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": "b57f2c5e-3498-45c4-b06f-482d4d29a95c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "ce7977e5-9569-4fb4-bffa-18123ef1c7ba",
"company_code": "sample string 5",
"company": {
"id": "e8f5de44-bf60-4697-8ad2-8c62328114ff",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-14T09:33:53.713103+00:00",
"sales_territory_id": "61286f33-bb76-4cc1-bcd4-0f67212de5be",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ff0e940d-7577-407a-82bb-127be5e3ea7c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "57817cec-42e7-4017-bc37-5178a36568fb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e25ee05d-89a8-4dcf-a1e9-77dc18f01c66",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "387c72e3-aa32-472a-9ea8-f334464bdcac",
"db_currency_id": "6715a60a-24f8-48a4-b323-ab0d09a5f9db",
"db_language_id": "a2138c63-b408-4ba6-94d8-8f14d031ba18",
"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-11-14T09:33:53.713103+00:00"
},
"modified_dateutc": "2026-11-14T09:33:53.713103+00:00"
},
"marketing_segment_id": "f80a30a3-e011-4443-a9d4-78145d1099aa",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a563172e-69de-4f2b-bef7-a9fa415b9263",
"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": "a0c21f73-20c0-42b5-8c1e-4365a4c2955d",
"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": "76d4cfa9-7738-4230-bb8b-676461e4d82a",
"db_country_code": "sample string 28",
"feelist_id": "8d62ec2e-0d5d-4742-b9dc-37f1cf71ad41",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "82ac277a-8d74-4278-82ad-520561b4d3e9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "4afa4131-b413-4260-8a59-526006ba0f0f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-14T09:33:53.713103+00:00",
"db_currency_id": "30ac9282-f72c-4455-aef9-b708d71f1371",
"db_currency_code": "sample string 10"
},
"company_type_id": "fb42e3d4-5a83-4ec7-a890-5df6d9c1f48e",
"company_type_name": "sample string 32",
"company_type": {
"id": "d8a34a4b-518b-4168-932f-4745ebd5cca5",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b969b3ec-0c72-4580-9fd8-c873b054c86e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "cc74740c-d183-440a-b519-d56134b9f3ea",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "4c84223d-9238-40e6-8a23-0fc10610181e",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "66709fce-5de4-4ce3-afa2-11333a8fb274",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "188be3c4-fc8b-4d39-bb8b-6075daf980f2",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-14T09:33:53.713103+00:00"
},
"company_sector_id": "88dadabe-683e-4aaa-a1e6-ef7bc173ef78",
"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": "31cb1162-b6c1-42b7-8e51-8553e0ca6fcc",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "92b1894a-06a1-4595-8131-f1c0b593c45d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "3a7afee3-abf7-4dbc-8f03-c05901f01a30",
"account_manager_user_code": "sample string 56",
"company_status_id": "bdbf5234-2913-476d-b5cf-ff4116ba474d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-14T09:33:53.713103+00:00",
"id2": 60
},
"db_language_id": "91938381-976e-4e12-8b92-30d55f2f95e7",
"db_language_code": "sample string 7",
"db_title_id": "32cd1605-d39a-4dd3-925a-e8ce4563250b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-14T09:33:53.713103+00:00",
"create_date": "2026-11-14T09:33:53.713103+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-11-14T09:33:53.713103+00:00"
}