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": "34810f9a-308c-490d-9c64-72a0c7d42da9",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b59fc142-a185-4a9a-a392-a16f3b1c5d73",
"company_code": "sample string 5",
"company": {
"id": "3c64847d-63de-4cbb-abdd-475349f20b30",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-24T08:16:50.8016647+00:00",
"sales_territory_id": "f579f059-41c1-4004-b035-282c28b2209f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a758a7cf-0795-4bc7-ade6-058b7086b03b",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4f4ff412-da47-47ea-939b-771d5509e016",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "dad5ae95-28fe-400f-b206-a460d0797fc4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "54a233d7-ff8f-4c0f-9b3a-48e70b6b727f",
"db_currency_id": "c099dfe6-582a-4176-82a2-2922377526a1",
"db_language_id": "b51235b2-4ee9-4563-b036-00057188f84b",
"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-06-24T08:16:50.8016647+00:00"
},
"modified_dateutc": "2026-06-24T08:16:50.8016647+00:00"
},
"marketing_segment_id": "30424f84-b32e-4314-aca6-859f61f9a2f3",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6aaf0340-7b26-458c-80b1-abcf2c5d58ef",
"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": "38ec0313-52ca-430c-8eed-154928b71bea",
"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": "55ddd0bc-b9fc-4b65-af5f-559335e891b4",
"db_country_code": "sample string 28",
"feelist_id": "a91b9904-6326-4cd9-8812-c37c4d80fa50",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d984c9ff-d591-441b-880c-423161b1d133",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "2d9b60da-6d0a-4c22-8f8e-4061e5ed9866",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-24T08:16:50.8016647+00:00",
"db_currency_id": "c080a6e9-80a5-451c-ba3c-4e9bef6c7c37",
"db_currency_code": "sample string 10"
},
"company_type_id": "2037b87e-4ccc-4054-adb8-963c194b456d",
"company_type_name": "sample string 32",
"company_type": {
"id": "0ce3d43c-511a-4457-9aa8-525cdc3bf0e4",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "846e1091-06f7-4efc-9344-4e5dca2f4880",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d119aa0a-36f3-478d-9ed7-dc7a846e38ab",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6ad3ea84-acb7-4127-b7df-6477c7550c45",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "ef6a32ce-3148-4473-8004-fb3ca0dc6174",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4f641eb8-f2ec-4d25-a0fd-3abb01dcb069",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-24T08:16:50.8016647+00:00"
},
"company_sector_id": "c36b9afb-a1bd-42c1-a8a6-ef9c6b4573f0",
"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": "745cf7ea-d651-444f-b0be-66f54fcb7f22",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5ae6db40-75e4-4b31-bf00-9592adee6755",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "dc806fe5-88ab-4a59-bb72-427bf8e53987",
"account_manager_user_code": "sample string 56",
"company_status_id": "dff97b4c-1344-48a5-97f1-eef812dfb3ed",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-24T08:16:50.8016647+00:00",
"id2": 60
},
"db_language_id": "929d45b8-d65c-461a-bf02-25fd53fbb89a",
"db_language_code": "sample string 7",
"db_title_id": "a6978902-de25-4043-9168-286df14ca706",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-24T08:16:50.8016647+00:00",
"create_date": "2026-06-24T08:16:50.8016647+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-06-24T08:16:50.8016647+00:00"
}