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": "dac8f480-5874-4055-8c85-b3a474d65563",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "616c4a58-a3aa-45f6-9a9a-3ca6e312e612",
"company_code": "sample string 5",
"company": {
"id": "9dab8a19-71c2-4ad5-a838-c5e54c62d5f6",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-07T19:22:40.1877471+00:00",
"sales_territory_id": "743a3ba0-86db-4165-af7d-5548b3637cde",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ef4d95b0-e7ec-4e90-8913-107d8a6fcc09",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cb64d43a-965f-40b8-aceb-de091f19d7be",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "27749cd6-a3e0-4d11-843a-847c21b78828",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9193c2d7-de12-4f3d-8c0e-06bd7094d601",
"db_currency_id": "99495c57-e033-470f-9132-a843631ab9e3",
"db_language_id": "5e940819-0e3f-43c1-9923-32be08a72e1d",
"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-01-07T19:22:40.1877471+00:00"
},
"modified_dateutc": "2026-01-07T19:22:40.1877471+00:00"
},
"marketing_segment_id": "cf3d7a71-286c-469e-94d1-45c13264a0c6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4d219eea-5351-42d6-9dff-a05746effe8a",
"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": "ea699844-4a6b-4a85-86ba-3f524ba171ff",
"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": "a624bc36-4055-407f-84f0-2b2957663aa7",
"db_country_code": "sample string 28",
"feelist_id": "9e9e8ca7-1a1f-4678-8dab-b98ea4b69cb3",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "23c396d6-9b1f-4074-9f2f-7dbde45975fe",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8347b13c-2f1e-418a-9e8c-cf4b997bac41",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-07T19:22:40.1877471+00:00",
"db_currency_id": "41a006d8-c0ab-4f43-87b6-4532ee75a9f5",
"db_currency_code": "sample string 10"
},
"company_type_id": "8533f121-7f61-4f8d-b6c8-8a7b6130ecaf",
"company_type_name": "sample string 32",
"company_type": {
"id": "6d7f4a08-270b-4045-902f-dbb3a8e65640",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bc78cf03-037e-4c0f-a630-6c9dbfe445e6",
"sales_organization_code": "sample string 5"
},
"db_language_id": "52c2eeb1-6107-4bff-9d84-03753778399c",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "8cd628aa-f183-4895-a1a0-2dd1afb1bc64",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "49147761-a7a9-41e4-9bef-d16015efa689",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4e2b915e-417f-47e3-beb4-6a9e5799b6f8",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-07T19:22:40.1877471+00:00"
},
"company_sector_id": "294fb663-a333-4c67-b93f-a042523734ab",
"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": "1b1e63e7-1e36-4cfe-a1aa-f5dd6e912b24",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e5a81728-6025-40f7-a6ab-caf321978e94",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "7f3ecb07-79cf-4790-a827-1ecc1529ae1c",
"account_manager_user_code": "sample string 56",
"company_status_id": "4092b292-20f9-4531-8ccd-5e2d379ad95c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-07T19:22:40.1877471+00:00",
"id2": 60
},
"db_language_id": "4c2bb9a4-9deb-489f-9ca2-339f59b0d086",
"db_language_code": "sample string 7",
"db_title_id": "c5c23fa7-f011-4256-9ad6-6aedb2f719fc",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-07T19:22:40.1877471+00:00",
"create_date": "2026-01-07T19:22:40.1877471+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-01-07T19:22:40.1877471+00:00"
}