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": "6229464e-1965-45cd-9bbe-71ce8c4c3d61",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "81e181be-31f8-4369-ace3-cdf3d2f8c1f5",
"company_code": "sample string 5",
"company": {
"id": "fd7f2ee3-8ca0-4648-a8d4-7177a7bb7047",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-17T14:49:39.3047964+00:00",
"sales_territory_id": "f3207d0a-ce14-4d3a-a815-4269f8536a9f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "8326a07d-fc70-427e-bed2-21cc86fc84ad",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "da27da00-5876-42ce-bf2a-7b0df17a4e75",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ceca293c-920e-4152-be6e-59814c37c9c8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c615c49-bfaa-4d51-9305-bc846806f727",
"db_currency_id": "788344fd-db8e-497f-a264-fadb0f3e1f62",
"db_language_id": "9af47248-f148-4e39-85ed-33bc2e4dc1e7",
"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-17T14:49:39.3047964+00:00"
},
"modified_dateutc": "2026-07-17T14:49:39.3047964+00:00"
},
"marketing_segment_id": "61e1390e-0add-467d-b4f3-6a42aa985873",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "17e3a56e-4731-4dc8-8f09-d1b969b7396c",
"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": "3cea30df-17e4-4a5e-86a7-54775cfbf9d1",
"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": "e1fd7b70-c749-4fff-b059-7d3e695ede63",
"db_country_code": "sample string 28",
"feelist_id": "aefadfc3-f25d-4bc6-95f0-045e2425d4d4",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "2192e4f8-fcbd-40ea-b9db-6cee912fd281",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "28b8935f-642f-4f7f-8042-37ece2101725",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-17T14:49:39.3047964+00:00",
"db_currency_id": "884d720c-d9b7-4a58-9745-6157c19249f6",
"db_currency_code": "sample string 10"
},
"company_type_id": "00c063e6-fd8f-4499-8a18-84c9f26ddae2",
"company_type_name": "sample string 32",
"company_type": {
"id": "d3c4de13-14a8-48d7-9519-0b33a6956148",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "afd319f0-3ad4-4124-99a4-f40ad893272b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "02e05f5f-884b-4080-aab2-020101b6d42b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "8b524895-c4b9-44a0-b668-abf5baa78d66",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "43782ae2-6b15-4847-9e77-659ac3bf12e2",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ce38bf24-2838-4e55-84b6-460144ab7124",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-17T14:49:39.3047964+00:00"
},
"company_sector_id": "1aa02249-f267-473e-948f-b3b4c5f1eaec",
"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": "65670f47-cf30-4e3c-96cf-24fc7516118a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2cc33ab3-859d-4147-bcd1-c729d1cadc58",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b50e035b-5dc5-4498-a8d9-83336e0eb80f",
"account_manager_user_code": "sample string 56",
"company_status_id": "1d4af54b-ff4c-4b22-8e06-dca7b819e0a2",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-17T14:49:39.3047964+00:00",
"id2": 60
},
"db_language_id": "343ad519-4605-4669-9a7a-5dfc47ff04f5",
"db_language_code": "sample string 7",
"db_title_id": "c33d0595-be49-4990-baab-a6df2259b9d5",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-17T14:49:39.3047964+00:00",
"create_date": "2026-07-17T14:49:39.3047964+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-17T14:49:39.3047964+00:00"
}