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": "9439a5c9-3105-4c9a-a14d-5a80df5fd0ec",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b702c57c-3994-4f10-88b1-8f74581aa26c",
"company_code": "sample string 5",
"company": {
"id": "c45c9deb-f355-47e4-9577-1f2f04b79d68",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-18T01:20:44.4430142+00:00",
"sales_territory_id": "bbcabed4-cdfc-4200-8644-14ba8acc9e9d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "82906026-3a8f-4eb8-ba3e-b85d0e2f1493",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "dd17ecbb-7fc1-46f0-b052-1d7c3430ad63",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0c06ed58-390d-4fb3-9522-364f121ea35f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "905fb979-97b1-4240-9d63-e9bc66d3c202",
"db_currency_id": "5390fb89-42b2-4cd7-aebc-b37802833faf",
"db_language_id": "a6bfa3d9-7399-4549-8708-636b06fa55fb",
"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": "2025-11-18T01:20:44.4430142+00:00"
},
"modified_dateutc": "2025-11-18T01:20:44.4430142+00:00"
},
"marketing_segment_id": "2c989a80-7dec-4169-9877-589ffd4a93c2",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "bd03434e-dbb3-440b-9c3d-5b3b961b69f6",
"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": "2b345408-1bcd-447f-86ca-40bfaaa3d7b9",
"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": "88a8e7d5-1241-41f9-b9e2-36a0b9ae1264",
"db_country_code": "sample string 28",
"feelist_id": "d769ffbc-d36f-44c3-8d5c-00c2d17467ea",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "4da1e1f2-db43-4416-8ab5-90fa3ce2bb6b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ac4963b6-ed4f-4d81-93aa-791fba1cc291",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-18T01:20:44.4586909+00:00",
"db_currency_id": "f6375cd9-7be1-4b4f-a935-f1ec1508c7dc",
"db_currency_code": "sample string 10"
},
"company_type_id": "906d331e-dd01-4886-b611-2a48735fe0fc",
"company_type_name": "sample string 32",
"company_type": {
"id": "611c23d4-caa1-4c3a-a4af-c6954e490a80",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2de06be6-56ca-41c1-a5a4-9f4f6eec3cb0",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b4653b5c-2a1f-4199-be64-d1862f0b0e94",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c2a9f09d-4b1a-4816-b011-47b76f713729",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "17a1c6fb-7fc0-4708-989a-52298f88291b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0315e53a-8c95-4025-b6c5-a7310a7c31f3",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-18T01:20:44.4586909+00:00"
},
"company_sector_id": "eeb2617d-11a0-400b-baab-f72a719a25b9",
"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": "e6c2305f-32d3-4ff5-9071-30521a651a7f",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "ba566e1b-dcec-4548-8174-ff845621a988",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8f2bbfb6-7a33-4913-bb04-2c28d70b90ff",
"account_manager_user_code": "sample string 56",
"company_status_id": "d0e5f019-e128-4efb-b900-338433375f67",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-18T01:20:44.4586909+00:00",
"id2": 60
},
"db_language_id": "f27b9a91-19d0-4ec8-986a-8ac22820dc9e",
"db_language_code": "sample string 7",
"db_title_id": "c6181af2-4308-40c9-9519-deda72870532",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-18T01:20:44.4586909+00:00",
"create_date": "2025-11-18T01:20:44.4586909+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": "2025-11-18T01:20:44.4586909+00:00"
}