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": "13a3d92d-c3db-4d6b-9f52-afaedea5b316",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2384bfb8-6cc6-4f61-aa83-1812483347f0",
"company_code": "sample string 5",
"company": {
"id": "b776a550-cc61-4f00-afc0-36d08073bd63",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-25T09:26:48.5069122+00:00",
"sales_territory_id": "92e77617-b17a-4dec-ad61-f343ee72308b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f3dd8642-a810-4c23-a27b-aa0a64d4256d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "07de0431-9d47-4130-bb42-e9ffc8c77400",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f1b6fb45-9d29-4ae0-973b-b4ada6290f26",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e23ed5b3-2695-4040-b4d6-4867b27048a1",
"db_currency_id": "26f33212-b5e8-4b54-940b-a4cdac311f4f",
"db_language_id": "621f8fc9-586a-4881-8dfd-4cd46cdefa98",
"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-10-25T09:26:48.5069122+00:00"
},
"modified_dateutc": "2026-10-25T09:26:48.5069122+00:00"
},
"marketing_segment_id": "c804616a-5a1f-4199-b331-dea383741f02",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b7bca45b-e300-4ef5-a67c-da46072eca48",
"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": "b94481e7-7acd-4779-a0b5-24a9b7dda546",
"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": "fdaa72eb-be54-41db-ad27-d8fbd04f25f6",
"db_country_code": "sample string 28",
"feelist_id": "e4be56f4-a13d-477e-906f-57368f9198d1",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "4d139687-4b61-443e-b926-854b137a443d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "27c00113-425d-4ad7-ae3e-74b6ea606a75",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-25T09:26:48.5069122+00:00",
"db_currency_id": "41d7bd19-7ba2-46c5-80b3-ccfb884c81a9",
"db_currency_code": "sample string 10"
},
"company_type_id": "5a7d3d8b-cfe5-4641-a90c-d49e55408fc5",
"company_type_name": "sample string 32",
"company_type": {
"id": "364f9ef0-adb1-4cbe-9b55-8b1a33f9f4d0",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5d88a163-705b-43e8-be41-1e68af15acce",
"sales_organization_code": "sample string 5"
},
"db_language_id": "6f2ea377-1748-47cc-8fea-65852ae72f51",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "98c22f41-150b-448a-8f34-127a95057c9a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "2ce6d0a9-f104-4de3-9056-0ac5ee50f2cf",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b66cc305-958f-4c5c-9f2f-a490501d32d0",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-25T09:26:48.5069122+00:00"
},
"company_sector_id": "d742365b-7681-4e72-a979-b5e79814c8d3",
"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": "c1f22a77-7b9e-4f13-a65e-2e229d9399a7",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "c2c02f5d-997d-4006-9f0e-9bb6aeb31772",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "26881677-fbd5-48d3-84a4-a4c3b93d97f6",
"account_manager_user_code": "sample string 56",
"company_status_id": "0907f251-cb01-4c23-822a-ac8366384f52",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-25T09:26:48.5069122+00:00",
"id2": 60
},
"db_language_id": "0a5907e1-86e3-41a9-a72d-b3aceac537ea",
"db_language_code": "sample string 7",
"db_title_id": "2d1389b0-1c4d-4496-b774-88d9728913ca",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-25T09:26:48.5069122+00:00",
"create_date": "2026-10-25T09:26:48.5069122+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-10-25T09:26:48.5069122+00:00"
}