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": "700f5b42-e879-42f5-a144-e0e3473f8f6c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "59791d72-e196-4417-a9ed-679c2297edc2",
"company_code": "sample string 5",
"company": {
"id": "3eb4f49c-6b6e-402d-b2c0-9621796576a7",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-20T09:17:08.8689231+00:00",
"sales_territory_id": "cba8f495-42cc-4a67-bf12-63574498ed0e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a5379d8a-28ee-4762-8b7c-39de9b5bd599",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f4b02fe8-fe6b-4ca3-8d12-43eb023f5347",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f7faba3b-e0c3-4f2c-80e4-bbccb8b0af38",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "421fc381-b3f9-463c-95ec-f97415daa773",
"db_currency_id": "6d5ea05c-b5cd-4223-aaf7-f4b1e03c6ca3",
"db_language_id": "8c05655c-c0a4-4d0f-872f-55ec8b216500",
"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-03-20T09:17:08.8689231+00:00"
},
"modified_dateutc": "2026-03-20T09:17:08.8689231+00:00"
},
"marketing_segment_id": "529ccccc-902a-4bd8-b88b-5d719764ff48",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7d58897f-62f1-48b0-a399-34d5c552576d",
"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": "454a2489-f205-4799-9f21-1e1362236964",
"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": "027c44f4-6f3e-48c4-ab26-df2015c50751",
"db_country_code": "sample string 28",
"feelist_id": "ee87bbba-6835-48e8-acce-c15d9ad50547",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e33602e1-3392-4488-a570-bce5ada89e3c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a0213086-a80a-4b5c-af58-0cdc24f6cfd9",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-20T09:17:08.8689231+00:00",
"db_currency_id": "81af8f96-1bfb-40a6-a2b0-faabde5afccb",
"db_currency_code": "sample string 10"
},
"company_type_id": "518caa69-033a-477d-b6df-60304c2673de",
"company_type_name": "sample string 32",
"company_type": {
"id": "a5f607d9-9fb8-4076-b66a-19d7726f338d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "468d803d-163f-4009-a620-e7d3c5bde489",
"sales_organization_code": "sample string 5"
},
"db_language_id": "2f094dfb-2311-43f0-ac2f-59e6235d4a79",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7460ac9d-b055-42b1-913b-a81e62276c10",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "8a379ae1-95d6-469f-8f48-b4be72e136a1",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2539a349-ff07-4e4a-8331-edac3a99583d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-20T09:17:08.8689231+00:00"
},
"company_sector_id": "e4a62fb7-bded-4ca0-ad67-84e084fa97ad",
"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": "0282da38-0ba4-4f76-a3e8-7e04a39213d0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "83b8a863-341a-4b04-ba5a-2d4bbbf2d26c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b16e49be-025f-494c-ba13-177b84965982",
"account_manager_user_code": "sample string 56",
"company_status_id": "a738e0cc-bf21-4e0d-bf3a-31b6a46bdc39",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-20T09:17:08.8689231+00:00",
"id2": 60
},
"db_language_id": "38a76ecc-a7c3-49b6-9576-fb5e1d2fb894",
"db_language_code": "sample string 7",
"db_title_id": "ff80f8cc-9a40-483d-a79f-56ee8ec2d2a7",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-20T09:17:08.8689231+00:00",
"create_date": "2026-03-20T09:17:08.8689231+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-03-20T09:17:08.8689231+00:00"
}