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": "9b66468b-090e-4939-8f77-eb9ae36860a3",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "cb0b3fef-2e44-4997-8704-104d739faa68",
"company_code": "sample string 5",
"company": {
"id": "e98e8153-0baf-4f92-9566-fe5e6f37556a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-02T03:50:06.3227729+00:00",
"sales_territory_id": "d7c895e6-8996-418d-afda-931207a527bd",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "6843f8c7-3b7e-43a3-9343-71af9f7ca1fd",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f18afa00-951e-45fb-ab82-f3755481493e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "658e1a8d-e5a1-4de3-8144-c7eae5e252e7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f458bdd8-ef8f-4cfc-90aa-e474d0ec4ee6",
"db_currency_id": "4fe79408-9abe-4a43-abcf-3efec938a793",
"db_language_id": "9798224d-cb45-4d20-8b72-48250c03412c",
"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-02T03:50:06.3227729+00:00"
},
"modified_dateutc": "2026-06-02T03:50:06.3227729+00:00"
},
"marketing_segment_id": "01d0d400-4113-4383-be61-82450852ee5c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "3a169126-d441-4751-8f45-f952025fc8e0",
"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": "028db6e8-0497-46e2-ba9e-22c4a67a7a1e",
"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": "64b9a9ed-34bf-4621-a751-88146ad28339",
"db_country_code": "sample string 28",
"feelist_id": "9b756ce2-082b-418c-b1ed-22df9424c488",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "41ee60b2-5911-4552-8358-7dde9cdc09e3",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "625cc27f-4b9f-4b43-9ac4-108275ec9005",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-02T03:50:06.3227729+00:00",
"db_currency_id": "bdfcfd67-da24-480d-85a0-0eae9f94a261",
"db_currency_code": "sample string 10"
},
"company_type_id": "2fbff376-dde7-4522-b5ed-51270c2658c7",
"company_type_name": "sample string 32",
"company_type": {
"id": "e04f4633-2085-4574-bfd9-a15477ec3fbb",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "89fa614f-9011-4a5f-bcee-e82dc9251c08",
"sales_organization_code": "sample string 5"
},
"db_language_id": "3f08acbb-3f63-4504-8099-5494eb8d6364",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "bcad914c-eae6-498c-8527-e133514db1bb",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4f785b6f-eaf1-4625-876e-473f30489bcc",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d16dedce-e33e-466f-ac2e-1b07ecf59b15",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-02T03:50:06.3227729+00:00"
},
"company_sector_id": "e3670668-f1ad-44f2-ba6e-8268a51d7211",
"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": "b64fc47b-60db-4747-b8c5-b3102663cb70",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "58ca831a-19e5-49fb-a98d-f6540c1581c3",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "735c6521-afe4-47e3-97df-18813a24e2c1",
"account_manager_user_code": "sample string 56",
"company_status_id": "ae595a98-f4cb-4889-80a0-3360b279981b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-02T03:50:06.3227729+00:00",
"id2": 60
},
"db_language_id": "2f775a87-f184-4878-9c8d-022a486cfd2d",
"db_language_code": "sample string 7",
"db_title_id": "70d1cd02-253b-4f8a-a969-649e25c89a9b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-02T03:50:06.3227729+00:00",
"create_date": "2026-06-02T03:50:06.3227729+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-02T03:50:06.3227729+00:00"
}