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": "76e555ce-06d9-4026-9022-2e681f8df336",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4058f9c1-a8b5-4cb3-ae3f-9c9af7bca35f",
"company_code": "sample string 5",
"company": {
"id": "5629eab9-491a-42b4-9a5f-f5f4b4a8acc3",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-17T09:39:37.6981061+00:00",
"sales_territory_id": "b408c71f-302e-42b1-ba84-42b6302c3b99",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e1e649b1-3b5c-4dd0-842c-0f5e379ae9b6",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "68366770-ea06-4614-a061-1c7e77c3e941",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "97ed1bb5-5b35-48e9-a9e1-c1251340c7eb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1444ed01-5dd9-40fb-88bf-0dfae7403349",
"db_currency_id": "485c0c50-b8ba-4f3d-8076-e3727abc6f73",
"db_language_id": "93f472ba-e45b-455b-8cd4-28ba9fb46ffa",
"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-09-17T09:39:37.6981061+00:00"
},
"modified_dateutc": "2026-09-17T09:39:37.6981061+00:00"
},
"marketing_segment_id": "1846daf8-7547-4d98-bc7c-5b4c2310e40e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "0e66e1ef-baed-49f2-9245-f069bf7214d8",
"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": "623d3c5f-1d98-455f-9cf2-714721ad603e",
"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": "7b23dca6-d230-473f-a348-4f6fb160b6fc",
"db_country_code": "sample string 28",
"feelist_id": "f4f5e6bb-581f-43e7-8d67-75b1cb054165",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5faa05ce-6925-4097-9185-6d7b4078732d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "52dcdeb3-4902-4df7-9700-bc5f2b9271e2",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-17T09:39:37.6981061+00:00",
"db_currency_id": "3622a683-58d2-4ebf-8e55-d3208f079d87",
"db_currency_code": "sample string 10"
},
"company_type_id": "c2730b63-89d4-4e17-9bed-46f3b3811c9b",
"company_type_name": "sample string 32",
"company_type": {
"id": "307be848-c23d-42a3-a877-615138c4575e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7384637d-ddbc-46e4-9df7-dd8aa4c0f3e2",
"sales_organization_code": "sample string 5"
},
"db_language_id": "6ade9025-7d16-465e-9eb7-7daae6b3b6f4",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "501df03e-bcee-412f-8226-e48d0d0468ca",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4121e65f-5366-43f4-aea5-8d72f351be7a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "680af639-21ce-4466-a82a-9c7f9a83b97f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-17T09:39:37.6981061+00:00"
},
"company_sector_id": "c848d2e7-13ad-4440-bf85-15c9a4d226ef",
"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": "f6a9bbac-2343-48bc-b8f4-d332f7608909",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "fd802d76-08ff-4157-ae5e-dc01e1a64fd5",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a656a81e-951d-4891-b102-0f460b807027",
"account_manager_user_code": "sample string 56",
"company_status_id": "8fe0a6ae-f5af-42ff-8cb7-dfb70981e600",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-17T09:39:37.6981061+00:00",
"id2": 60
},
"db_language_id": "be39420d-abe3-478e-91d8-422e348bc93a",
"db_language_code": "sample string 7",
"db_title_id": "19ccf8fc-29c8-4585-80de-82ad99131808",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-17T09:39:37.6981061+00:00",
"create_date": "2026-09-17T09:39:37.6981061+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-09-17T09:39:37.6981061+00:00"
}