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": "f1c80da5-9ef9-4ead-ab54-cb1585666440",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c6ac725c-42d7-422b-880d-bfc51147eb68",
"company_code": "sample string 5",
"company": {
"id": "fd0ac9f9-5f6a-4bdf-b2f0-027c3bcc455b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-13T18:11:13.6511123+00:00",
"sales_territory_id": "4e9d53b5-652f-453a-9c1b-8135a4c166e6",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "6b432527-45f6-48f4-b444-9b5028c56945",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ae69d39f-d550-44ec-9152-3424a666cfa3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5584b772-35a9-4ab5-9c34-6436c42806c4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ab8f0b15-923b-4752-ac2a-116032504b02",
"db_currency_id": "086343f1-8684-4618-9d22-c2b1d709ec98",
"db_language_id": "09c56438-3f57-4c2d-b9c8-0fa24df12ad9",
"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-13T18:11:13.6511123+00:00"
},
"modified_dateutc": "2026-01-13T18:11:13.6511123+00:00"
},
"marketing_segment_id": "5af0ad23-9276-4408-86a6-1e082079e4e0",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a7949dea-2a9f-4264-9ff9-8c6396cfdff7",
"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": "e7853ee2-7033-4dbb-ab62-8b195d708e61",
"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": "b1dbeb8f-1215-4d13-99f7-5fe344bef406",
"db_country_code": "sample string 28",
"feelist_id": "4de5b1ca-d8b3-47df-b368-93c1a3a259df",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "2040c626-cbb6-431d-81f6-35247f476265",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d94beefb-85bb-4bcf-b469-d4d6aca4ba19",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-13T18:11:13.6511123+00:00",
"db_currency_id": "efc5ca9f-246b-4e32-bf7f-6b54cef166ae",
"db_currency_code": "sample string 10"
},
"company_type_id": "120ba3d6-9721-4fdf-b868-10987038045b",
"company_type_name": "sample string 32",
"company_type": {
"id": "2683559d-a04d-4427-904c-df7b6b5e080b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "15e95cdc-0968-4e68-98ba-a71ae5bcb681",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a1b9f43c-7223-4eca-8264-82b8a072394f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3cf997f5-f321-47ec-b5d8-fb125662cadd",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "56a5bb56-9a9b-402e-a502-4b37d25c09cf",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9ee1b584-161a-4385-81e8-813eb5c42ae2",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-13T18:11:13.6511123+00:00"
},
"company_sector_id": "7f30258e-d8e5-4134-9812-38ea366471ae",
"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": "6ce8233d-c7aa-4f21-8821-045cb598021a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1c527815-d667-43de-a949-082e0462bdc9",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f8133f0b-bf9a-41cd-b43e-161f9def98fd",
"account_manager_user_code": "sample string 56",
"company_status_id": "927d2941-f6c7-46a4-8919-95e3f0e530f1",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-13T18:11:13.6511123+00:00",
"id2": 60
},
"db_language_id": "97bc488a-8c39-48ee-a429-656926d3ba45",
"db_language_code": "sample string 7",
"db_title_id": "e1811612-29b5-4e58-8236-abf34c84034f",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-13T18:11:13.6511123+00:00",
"create_date": "2026-01-13T18:11:13.6511123+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-13T18:11:13.6511123+00:00"
}