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": "887a947e-ee9a-4b9f-9971-105a4c371bdd",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e354799d-315f-47e0-a584-901d579c9bbf",
"company_code": "sample string 5",
"company": {
"id": "611a9723-87e4-4f6e-9daf-e48f4a45aa5f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-17T21:58:56.2373243+00:00",
"sales_territory_id": "7f91890a-08c2-4f22-a4c0-4ccc68d622c7",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "efd2e1eb-2b85-4886-8fba-86a6494cbb2c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d7a285f9-e16d-4cd0-a0f6-c52641e7fd59",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3b98c93d-5d13-43bf-b552-600f785548ee",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "557861fe-aae1-4bc7-b0a0-519ac4198cdc",
"db_currency_id": "34bb392e-9187-43ef-b435-4682417dcaf2",
"db_language_id": "5473f8a0-09d7-4400-b102-522d9b6215af",
"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-08-17T21:58:56.2373243+00:00"
},
"modified_dateutc": "2026-08-17T21:58:56.2373243+00:00"
},
"marketing_segment_id": "01fac27e-c985-49cd-be93-c9cfd40d9d40",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "072a980d-7f0b-4db3-afff-54b1341c2082",
"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": "998fbc68-19b6-4a3a-89c6-43c458ba3778",
"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": "52f0d473-1823-42f8-9dfd-869d14502cf1",
"db_country_code": "sample string 28",
"feelist_id": "6f50c593-911e-41ee-a11a-6f2780ffd8b7",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d079fc60-9637-42f1-8493-16998a80929a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "bfe59086-3ca9-4daa-b7d5-c466b5521dc0",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-17T21:58:56.2373243+00:00",
"db_currency_id": "41ba197d-9856-4481-9422-f7097f8e8250",
"db_currency_code": "sample string 10"
},
"company_type_id": "4331517b-ba3a-4dc1-8148-632231c8374c",
"company_type_name": "sample string 32",
"company_type": {
"id": "70199a02-a12d-4d0b-83bb-274ac56d8f60",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "86eafb7b-b855-4eba-95ac-b3e616b38daa",
"sales_organization_code": "sample string 5"
},
"db_language_id": "32abbad8-80ad-48a6-b7bb-4e7e3599d8c9",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "70b1aac1-437a-41e4-96bc-627465b7590b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "fa89656e-9cb7-4367-8be2-44d3bd327756",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "44c4ce8d-1bd6-4b29-9b18-a394c5281212",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-17T21:58:56.2373243+00:00"
},
"company_sector_id": "29a24f9b-b3a1-4bce-80e7-0a33267156bf",
"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": "8f722bf7-b4dd-4851-96dc-bc018e7780c6",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f0c93841-6f94-462b-8e79-fe30236fd503",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "adca56d8-9562-48f2-bea7-fe4f0a71edf6",
"account_manager_user_code": "sample string 56",
"company_status_id": "4a0b2ca1-d2cf-4df5-a01b-709e153bbd82",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-17T21:58:56.252945+00:00",
"id2": 60
},
"db_language_id": "7336702c-ecbd-44b3-90de-ae874da93344",
"db_language_code": "sample string 7",
"db_title_id": "6a0ba7ed-3460-4f7a-a877-5c132f8f23af",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-17T21:58:56.252945+00:00",
"create_date": "2026-08-17T21:58:56.252945+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-08-17T21:58:56.252945+00:00"
}