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": "d786c87f-81cd-4adf-9eab-8895175b60d0",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "81bff65f-d408-40c9-a86f-1b13055fad6b",
"company_code": "sample string 5",
"company": {
"id": "56fb636c-8afd-4194-900c-f459071ba653",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-30T08:40:25.9205807+00:00",
"sales_territory_id": "67f6054f-651b-45ca-bd4f-bbc9b253a805",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "954658f2-c8e9-43a3-a450-63222f0ac08a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e57a6056-d626-448b-873b-4e391053ef78",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9d840510-553e-424a-b83d-66cddf99db1e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "575bf037-2ee5-434a-8a8b-4ffcc8ba085a",
"db_currency_id": "8db8da02-d45c-46b5-8bfb-2eeed2991912",
"db_language_id": "e51749de-52fd-4d0c-a5dd-3d32d37f5f24",
"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-06-30T08:40:25.9205807+00:00"
},
"modified_dateutc": "2026-06-30T08:40:25.9205807+00:00"
},
"marketing_segment_id": "8bcaaacc-a906-4641-8c10-aac27179f689",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "3f19b5b2-7208-43cb-95c0-c755dfe36f37",
"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": "15c05a50-be93-472c-a525-45ed88f0d982",
"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": "839a1610-1128-4314-8f28-d91549a21a28",
"db_country_code": "sample string 28",
"feelist_id": "f9ba98db-48ea-481a-b104-77157d3e0203",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "9fad94a1-421b-42d7-a232-35b25785783b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "98e28469-72ab-4471-98b4-ad463941759a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-30T08:40:25.9205807+00:00",
"db_currency_id": "467f726d-fd1b-4c0a-a466-7ccebde44ccb",
"db_currency_code": "sample string 10"
},
"company_type_id": "dbea7d47-74c0-49d5-985d-0d1102663763",
"company_type_name": "sample string 32",
"company_type": {
"id": "0de41e15-6c0f-45c8-9794-530c88e971b5",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d00943b6-805f-4424-85cc-d372535e40f0",
"sales_organization_code": "sample string 5"
},
"db_language_id": "51d8572e-faeb-47d5-92d7-02f94c510bd4",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "952ecd23-ec5f-4c8d-8c9b-366c9b175674",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4e1112cf-2fdb-47be-bee2-267a9df3b279",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "848d1fca-aaf6-411b-a626-9af64afe7bd1",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-30T08:40:25.9205807+00:00"
},
"company_sector_id": "d0e2301b-6ed1-4411-b0f8-42fd3d3a5018",
"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": "61f5959d-f7d6-4cf9-a2e5-229fc3d1c8de",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "90386786-3417-4ec8-9306-097f738d2022",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "75c0babd-77ef-40df-b41c-ef170ef265c6",
"account_manager_user_code": "sample string 56",
"company_status_id": "1c4ea2d4-66a6-464d-a305-d7a0a8b6d529",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-30T08:40:25.9205807+00:00",
"id2": 60
},
"db_language_id": "07a6f7d6-07b3-4f75-ac4c-df86612fe2e7",
"db_language_code": "sample string 7",
"db_title_id": "98cfac30-7c13-49e6-9f78-5ba6ac9389d2",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-30T08:40:25.9205807+00:00",
"create_date": "2026-06-30T08:40:25.9205807+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-06-30T08:40:25.9205807+00:00"
}