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": "102304f2-49cb-4c6f-83d7-ffc115f56c0e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0adb5561-1700-4525-b767-a98f7298e8ba",
"company_code": "sample string 5",
"company": {
"id": "1c265874-5c0d-4df0-895a-688df5812302",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-16T22:46:54.9768185+00:00",
"sales_territory_id": "f3ea5805-72e2-406d-a260-0caac3d0202f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "fd395fca-ffaa-4dd6-b3a6-de1905f0b8de",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "627f5397-ea70-42ed-9271-2b64ea9ceeb0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4255558f-3e0d-4e45-8c05-ec5364416775",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c75e86cc-26c0-44e4-9d42-aefa87fb30e4",
"db_currency_id": "cb1203e1-18c2-4d33-bf92-bbfd56e92e11",
"db_language_id": "f1970289-48c9-4714-994b-cc48de1a06d0",
"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-01-16T22:46:54.9768185+00:00"
},
"modified_dateutc": "2026-01-16T22:46:54.9768185+00:00"
},
"marketing_segment_id": "e9d98ed8-65e7-4ee4-967f-f78f3db2ad88",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "46cc0fe5-2e56-4439-a752-a79b0aa7b164",
"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": "916f4121-a0a0-48e2-bee6-62a7cc4f266d",
"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": "110a73e8-a569-47e4-8db5-fe5e74073dbd",
"db_country_code": "sample string 28",
"feelist_id": "1ab36537-9552-4dae-88c3-14b4aed6dd69",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1b39e90f-5a3d-4d5c-a07b-6b3225c75cb3",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d2d928cc-607c-40fd-98f0-ce6f8cb8a88d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-16T22:46:54.9768185+00:00",
"db_currency_id": "0e117232-f6a9-49a6-883e-b5d62480ebe8",
"db_currency_code": "sample string 10"
},
"company_type_id": "16e9106f-1753-4c44-87b8-bb9c286ea049",
"company_type_name": "sample string 32",
"company_type": {
"id": "30c13234-6a7b-4f8f-afa4-4548f24bd8b8",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a3f18b95-21c8-46e9-8ce8-f34e65851e7f",
"sales_organization_code": "sample string 5"
},
"db_language_id": "3b09aa3f-9ad8-4ffd-9236-3802ba8bda5e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c9b92ba3-8271-49c0-9b7a-3e142e06c181",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "eb9ff4ef-d771-4ebe-afa9-528d74f90c85",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a4592ca7-48f0-4ba7-a9ef-26133c5376fa",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-16T22:46:54.9768185+00:00"
},
"company_sector_id": "19da4a40-9ad6-4efb-ae82-f567de40fe1d",
"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": "06fe00f0-fa70-468e-88ba-236397c08a06",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "c5ef9665-2ea4-49ce-9fa2-ad14a542e527",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ce634176-4fa8-465a-8707-af8066be2c56",
"account_manager_user_code": "sample string 56",
"company_status_id": "7a11ee51-8272-4b97-a3e9-16c22bcded57",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-16T22:46:54.9768185+00:00",
"id2": 60
},
"db_language_id": "0ab6d056-27b1-4faf-8fa9-285b24c04d03",
"db_language_code": "sample string 7",
"db_title_id": "b3213401-2225-418f-80cc-b2a2ec9234c9",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-16T22:46:54.9768185+00:00",
"create_date": "2026-01-16T22:46:54.9768185+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-01-16T22:46:54.9768185+00:00"
}