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": "f84c595e-4484-4a9f-b72a-8560f6d05691",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "ec85d537-2cfc-4e87-91cb-e2f303761365",
"company_code": "sample string 5",
"company": {
"id": "769592ba-8e63-4874-a2ef-507556cef40f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-09T10:08:41.5904989+00:00",
"sales_territory_id": "86572bfb-3ab1-45e1-8818-5e40908061e3",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a6e131ca-955d-43ba-a9ab-ab108a8d1eb7",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0222049c-1847-46a6-bdf8-2ccbedc293e8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9eca8d76-25af-4348-a52b-d940642b20e5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "13ddc2ad-9453-496d-b223-ef2d7a4f3e7d",
"db_currency_id": "21f31b25-1e85-4ef1-9a4e-bd720818deac",
"db_language_id": "bd1f9e3c-ef27-4ce1-9bc6-203003ad26ec",
"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-07-09T10:08:41.5904989+00:00"
},
"modified_dateutc": "2026-07-09T10:08:41.5904989+00:00"
},
"marketing_segment_id": "a9b06d79-3c93-4d8d-b7e8-f77c12f98222",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ce052eec-84b1-4247-be01-872531b03f44",
"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": "8798b71a-70e8-4fa3-a14b-b88356b2f6b6",
"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": "abe719df-5a79-4041-a65f-cdc47a1c58c3",
"db_country_code": "sample string 28",
"feelist_id": "22f11348-ac6f-4118-aa7b-f5e8793e6adb",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ffbd4af0-7042-4a90-8a88-c07759bf5889",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "6084d890-6205-436e-9588-c9acc3a6c30e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-09T10:08:41.5904989+00:00",
"db_currency_id": "652e0e37-a668-4f7c-9e2e-e6faaf6c800e",
"db_currency_code": "sample string 10"
},
"company_type_id": "62c7ec7c-baf2-4f51-ac65-5bebbaede3e3",
"company_type_name": "sample string 32",
"company_type": {
"id": "6ddd9aac-e65c-4db9-a339-8e2259e38dd0",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b8928f7b-8942-4774-a621-a593305a2972",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9a717a03-fcbe-46c5-9061-340ede85e96b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f591a6f3-f69f-4a42-ae63-2ce91882497f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "3b65105f-e183-4eeb-b971-2f1510c8a79b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d9cfa07a-8022-4fa5-8130-68bd9a7ac9a3",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-09T10:08:41.5904989+00:00"
},
"company_sector_id": "5de97ce0-97e9-4c1f-953c-16f09d9d3737",
"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": "4e207cfb-635b-4fdf-9439-921269a9c614",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "8e10014f-c3a8-404d-9960-3627cef85fb7",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "3edfb8bb-d98a-4fc6-a19a-65ae3aecee15",
"account_manager_user_code": "sample string 56",
"company_status_id": "d000aeb0-3309-437a-9496-72fe24d95bf2",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-09T10:08:41.5904989+00:00",
"id2": 60
},
"db_language_id": "8fc07cf1-0849-4b60-beff-2f7c1cb3ec59",
"db_language_code": "sample string 7",
"db_title_id": "1c2a3d35-f8cb-4f49-b83b-4668bb66cd09",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-09T10:08:41.5904989+00:00",
"create_date": "2026-07-09T10:08:41.5904989+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-07-09T10:08:41.5904989+00:00"
}