Get Contact by email
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
|
Email of contact |
string |
Required |
Body Parameters :
None.
Response Information
Resource Description :
contact| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary key |
globally unique identifier |
Required |
| firstname |
Firstname of the contact |
string |
Max length: 50 |
| lastname |
Lastname of the contact. If you have one single field available for firstname+lastname then use Lastname |
string |
Required Max length: 50 |
| company_id |
Company of the contact |
globally unique identifier |
Optionally required : company_id,company_code or company must be provided |
| company_code |
Embedded entity "company" using ERP PK when adding/updating contact |
string |
Optionally required : company_id,company_code or company must be provided |
| company |
Embedded entity "company" when adding/updating contact |
company |
Optionally required : company_id,company_code or company must be provided |
| db_language_id |
Language of the contact.If empty, will use the default on the system |
globally unique identifier | |
| db_language_code |
Language code entity using international isocode when adding/updating contact |
string | |
| db_title_id |
The title of the contact |
globally unique identifier | |
| archived |
Archive this contact to not have it anymore on the search |
boolean | |
| functions |
Function of the contact (ServiceManager,...) |
string |
Max length: 64 |
| e_login |
Login of the contact (if have access to ServiceDesk) |
string |
Max length: 50 |
| e_password |
Password in clear text of the contact (if have access to ServiceDesk) |
string |
Max length: 50 |
| notes |
Notes/Remark field |
string | |
| birthdate |
Birthday date |
date | |
| create_date |
Creation date+time |
date | |
| phone |
Phone number of the contact |
string |
Max length: 50 |
| mobile |
a number of the contact |
string |
Max length: 50 |
|
|
string |
Max length: 250 |
|
| skype |
skype |
string |
Max length: 250 |
| private_phone |
Private phone number of the contact |
string |
Max length: 50 |
| private_mobile |
Private mobile number of the contact |
string |
Max length: 50 |
| private_email |
Private email |
string |
Max length: 250 |
| reference_back_office |
Field used for Embedded entity (store there your ERP PK) |
string |
Max length: 50 |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Response Formats
application/json, text/json
Sample:
{
"id": "b4fa8ec4-ffa7-48c5-a375-be897be63edd",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4d958457-7ae5-450d-acce-732d1002e8d9",
"company_code": "sample string 5",
"company": {
"id": "87fc0dd6-92db-492b-a74a-b22377d0f136",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-26T07:45:49.0619324+00:00",
"sales_territory_id": "dc7e9a9d-2462-4ff7-9c5c-586b7caa71c3",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ae70d54f-cd06-4869-9515-f60c1e0865a6",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0f62d7e7-c0a9-47ef-a0a3-c897028ae974",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "715f2838-c852-4dc7-89b0-f8d4adf97789",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "95fed3b7-3ce1-4a78-8e91-e78375920b92",
"db_currency_id": "d527f055-7275-447a-a224-b0a9482ca2ff",
"db_language_id": "9f923024-244d-4165-a46f-e8f20fea2d1b",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-04-26T07:45:49.0619324+00:00"
},
"modified_dateutc": "2026-04-26T07:45:49.0619324+00:00"
},
"marketing_segment_id": "20a8c0df-b6b3-4cc5-b4e0-2aef9e5ad1bf",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "9c35166a-9fa1-4939-8883-559a58384094",
"sales_organization_code": "sample string 13",
"company_sales_status_code": "sample string 14",
"vat_reg_code": "sample string 15",
"is_working_address": true,
"parent_id": "0b039119-d225-4652-947d-91d28e25b0ea",
"parent_company_code": "sample string 18",
"phone": "sample string 19",
"fax": "sample string 20",
"url": "sample string 21",
"email": "sample string 22",
"street": "sample string 23",
"street_number": "sample string 24",
"city": "sample string 25",
"zip": "sample string 26",
"db_country_id": "4c223296-e55e-4fe5-8c3d-4abff57e0fed",
"db_country_code": "sample string 28",
"feelist_id": "217ad8ac-67f3-46b2-ad32-e92debffd026",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "cfcd58a5-e5ba-4543-b942-f14c9ee5aafb",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "4ea9bb6c-cf31-441e-b927-66ffeb0c4914",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-26T07:45:49.0619324+00:00",
"db_currency_id": "3e7deb57-fbea-40f5-8a49-dded13b013f2",
"db_currency_code": "sample string 10"
},
"company_type_id": "c44bc8ef-f89d-44c6-9631-3a9b18ad11fa",
"company_type_name": "sample string 32",
"company_type": {
"id": "bfd75b9a-9225-452e-b110-a164ffeabbe4",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8ad2baa2-15a7-40d4-8825-99ac3e90850d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "164b6870-01bb-49e3-835a-756a245c9a13",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e8dca6f9-a0cf-4540-931f-0860275eea26",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f82a9797-1924-46e4-af3c-081bbcefc595",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ec330701-0e6f-4917-b8e4-0156ba1ebcbb",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-26T07:45:49.0619324+00:00"
},
"company_sector_id": "921da939-30c0-4b69-a65f-c39b4755e832",
"company_sector_code": "sample string 41",
"is_lead": true,
"is_subcontractor": true,
"latitude": 1.0,
"longitude": 1.0,
"street2": "sample string 44",
"bic_code": "sample string 45",
"specialities": "sample string 46",
"register_number": "sample string 47",
"register_city": "sample string 48",
"bankaccount": "sample string 49",
"mobile": "sample string 50",
"service_manager_user_id": "adaabd29-b325-4444-ba71-eee2e2bc716f",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e66ae3f2-295e-47c0-8b6b-45d9847a0104",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "1bcd130e-bb46-4407-9cde-7682eb9fb664",
"account_manager_user_code": "sample string 56",
"company_status_id": "99a7d8b2-4792-42cb-9fa9-6c11625c0b8f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-26T07:45:49.0619324+00:00",
"id2": 60
},
"db_language_id": "2b23e29d-2617-429a-9d7d-6d98c10ad60a",
"db_language_code": "sample string 7",
"db_title_id": "54467a8b-44bf-4921-b382-df6a4cad66fd",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-26T07:45:49.0619324+00:00",
"create_date": "2026-04-26T07:45:49.0619324+00:00",
"phone": "sample string 16",
"mobile": "sample string 17",
"email": "sample string 18",
"skype": "sample string 19",
"private_phone": "sample string 20",
"private_mobile": "sample string 21",
"private_email": "sample string 22",
"reference_back_office": "sample string 23",
"modified_dateutc": "2026-04-26T07:45:49.0619324+00:00"
}