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": "5cb546ec-c034-4801-b847-361732164771",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4ea742c6-530a-4109-aa33-ddd81eb8d3b3",
"company_code": "sample string 5",
"company": {
"id": "e21f894b-b847-4ed2-8b2d-2adb14c69ab6",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-11T12:43:44.4187278+00:00",
"sales_territory_id": "b461d152-c672-495a-ba5a-ddcb576d9105",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0b627e39-d7cf-4c46-9875-0fb3af49ad08",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e2fd7802-3607-40c6-b58d-285b729c4d9c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9a33591e-f944-4daf-a265-78759d54a747",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bf52a183-d808-4596-bfc6-1bb6d8c3b60f",
"db_currency_id": "34f43725-168d-404b-a80e-50146663db01",
"db_language_id": "051aee00-893a-48b9-af61-80689c9e5885",
"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-11T12:43:44.4187278+00:00"
},
"modified_dateutc": "2026-01-11T12:43:44.4187278+00:00"
},
"marketing_segment_id": "cdfc9b54-2136-451c-af44-f7f5e8d4f91b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c85f43c6-2424-46fd-95d1-ba89e2c51ea9",
"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": "a87e72e7-69cf-421d-b726-1df9a1de2444",
"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": "266aa716-39c6-4504-8dbf-57eeaa144d5c",
"db_country_code": "sample string 28",
"feelist_id": "51fbbce6-ec5d-4212-8ef4-6ffe51fe1de2",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "567c578b-b3ea-4075-92f5-6909d0df172f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "745d9452-7766-40c4-a5ba-c7cc1798dda9",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-11T12:43:44.4187278+00:00",
"db_currency_id": "97816c61-42b8-48d0-963a-8b846e27ceb7",
"db_currency_code": "sample string 10"
},
"company_type_id": "27b554ea-88dd-4c75-91e1-0f0de1cc74bd",
"company_type_name": "sample string 32",
"company_type": {
"id": "50cd807a-e44e-4a14-98c5-a0f66df3abe3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0a3d88f2-2dcc-47a2-bcba-c40cb3b2ef84",
"sales_organization_code": "sample string 5"
},
"db_language_id": "2979dc66-63b2-4a88-a0eb-6aa73702533d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "721e11c0-f733-4c65-a737-6a1c957520e8",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c83fc296-aa9a-49e8-9096-d140fdfb3c45",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "5234cfdf-a8db-4e2c-87c8-35f56009f78b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-11T12:43:44.4187278+00:00"
},
"company_sector_id": "6d8500c3-692b-4905-9400-448f10b6b5d9",
"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": "e9c16b3f-ae77-4f76-ae08-3f2c62ba41f7",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "adcb0049-2f54-4fcf-b712-404ae5975f83",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "942af4e7-89cd-4e18-9f5b-81b941087b46",
"account_manager_user_code": "sample string 56",
"company_status_id": "771fbc98-eeea-48c1-8607-881b7f50d1a0",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-11T12:43:44.4187278+00:00",
"id2": 60
},
"db_language_id": "8cb2acda-9227-4485-b9ff-df292f6931bc",
"db_language_code": "sample string 7",
"db_title_id": "9f281a4b-e0f9-4a4b-955c-8295451a6743",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-11T12:43:44.4187278+00:00",
"create_date": "2026-01-11T12:43:44.4187278+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-11T12:43:44.4187278+00:00"
}