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": "4c02eb77-aad2-4b61-9335-893c7050deb6",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "6ad5862b-ab01-4f32-b41e-39be9b4ea898",
"company_code": "sample string 5",
"company": {
"id": "656f80ee-13f9-456c-b0a0-01e60c43c615",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-05T23:37:24.9354733+00:00",
"sales_territory_id": "ba171aa2-2a6e-4b5f-8ad8-aeba849a11ad",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "7eb2969c-f871-453f-9dc5-27d01b1d0f8a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0196f1f2-c496-45c8-9fe3-5ee04733e2d8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1806f68f-1ea8-40e6-acce-ad0e088723fc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "258c7416-31e1-415f-9e0c-ca7668a7c7ab",
"db_currency_id": "1a00c7d0-50f1-4c6a-b4b9-8aaf3b0fb5dd",
"db_language_id": "c8e56639-8bbb-4aa9-a002-8b0f64dd64fe",
"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-05T23:37:24.9354733+00:00"
},
"modified_dateutc": "2025-11-05T23:37:24.9354733+00:00"
},
"marketing_segment_id": "42dc1099-35fa-46c5-abc4-0e63458e869a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "84f9b5f8-1d64-4b37-ab92-08aef0a4b1cb",
"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": "8b84f43a-2054-4591-96cf-6d4d0671d6cb",
"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": "77a901b2-c035-4405-a0fd-8a1412eac8dc",
"db_country_code": "sample string 28",
"feelist_id": "da485d9b-0e93-4d9f-97f5-c048c1a17ff1",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "7a0f77a3-b25e-4894-b787-b6a750e925c2",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "74d28cbd-a361-4144-ac5d-39eca7db4652",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-05T23:37:24.9354733+00:00",
"db_currency_id": "69244325-bea9-42f7-878b-77686a5b86dc",
"db_currency_code": "sample string 10"
},
"company_type_id": "5b7a2507-c08f-48c0-9620-ae45329e80a1",
"company_type_name": "sample string 32",
"company_type": {
"id": "eb7a2a4e-bb6d-41bb-bb41-c614695075d4",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c456984a-aeb4-4472-8411-6568a4b6072f",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9c6dbc09-9031-4aa3-8ff7-eb3b8cb8b345",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7d43013d-8cbf-4561-b2f2-5bfb16d7e090",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b6857f9f-72b7-499f-88ac-8fa6c1ebce15",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "fdc0fb82-1e76-4ef8-b50f-b11cabb2e4cf",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-05T23:37:24.9354733+00:00"
},
"company_sector_id": "91c7cd0e-030d-4f62-8881-1fb46fe31d26",
"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": "541cbd11-eba3-4f28-8ffb-ff5632e72bd5",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2157990c-34f1-48af-849e-5c0d53ad25dc",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "dedc88c2-bcc7-4bc4-9603-b43e11f0a420",
"account_manager_user_code": "sample string 56",
"company_status_id": "724550c5-90f5-48ea-acac-2562deb782ac",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-05T23:37:24.9354733+00:00",
"id2": 60
},
"db_language_id": "1138e83f-056f-4d89-9bda-ffed4cd9bc8c",
"db_language_code": "sample string 7",
"db_title_id": "a8ebbb3a-0343-4e9c-914b-725d5a98827e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-05T23:37:24.9354733+00:00",
"create_date": "2025-11-05T23:37:24.9354733+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-05T23:37:24.9354733+00:00"
}