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": "801f3a66-bfb3-442a-909f-cc9ecf35aca8",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "25da20a0-5ca0-4020-8a09-32b26a996572",
"company_code": "sample string 5",
"company": {
"id": "17b53d0a-47dc-4903-9092-dbdb0fd96a3b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-28T15:43:32.4221365+00:00",
"sales_territory_id": "1c299ef2-9e9b-4578-ae21-143877da5018",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "92e7f417-e9a9-456c-9539-327ebf9f3104",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8a939b58-4185-4fdf-9226-07c49d0509db",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1500f4ac-059c-40e5-9d55-4f6620857843",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b2074da8-17d5-4440-a651-256ef33706a5",
"db_currency_id": "91018310-139f-435c-a20e-8185a0a6fdc7",
"db_language_id": "9d8c278a-5c8f-4a35-86e9-8ee65db8ae8d",
"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-07-28T15:43:32.4221365+00:00"
},
"modified_dateutc": "2026-07-28T15:43:32.4221365+00:00"
},
"marketing_segment_id": "910be156-2c59-4073-9106-bf27ef0d45e8",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "95204738-41e1-4a6b-a44d-cf1aeb38b075",
"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": "c550739c-ed24-4885-b382-773fe9e58864",
"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": "e5efe2f0-86d7-4ffc-8522-c92d986bd2e2",
"db_country_code": "sample string 28",
"feelist_id": "eaee795b-350c-425e-968f-9bbab57f0965",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "21403f03-94fc-40f5-bcea-9f0c697889d1",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "01db3341-3b77-4ec5-af90-0e146bf0ab1c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-28T15:43:32.4221365+00:00",
"db_currency_id": "2b5dd9cf-42b9-488c-8a41-475edb0154d9",
"db_currency_code": "sample string 10"
},
"company_type_id": "c2e62bac-8f5a-40ff-add3-10c6da30fc02",
"company_type_name": "sample string 32",
"company_type": {
"id": "3990f70f-e246-4a11-97ef-c6ee18cfdcd4",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0110010f-f86e-4fdc-a5f1-df553a792068",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c989908f-4106-4e9c-a62f-9d92a40bb8eb",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "806e1525-4a6d-4ce7-8426-d22c5ae07092",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "904e01cb-6c68-4e8f-b327-07028900df4a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ba2e10f2-ac8c-437e-ac68-f883c0d87c45",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-28T15:43:32.4221365+00:00"
},
"company_sector_id": "d34cdd65-b4d9-4727-b1ca-69d5113d26ec",
"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": "6ab2c4a4-695f-4ea5-8d28-7b2ae79ad0e4",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "bcd59212-3457-4c0d-814b-cdc6cb529283",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "207aad62-35ef-4333-a9f6-dfe9a15c8c7e",
"account_manager_user_code": "sample string 56",
"company_status_id": "fc134c5f-1a11-467d-b47d-3e0dcbf0dd30",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-28T15:43:32.4221365+00:00",
"id2": 60
},
"db_language_id": "bee7f906-cfbf-4ab4-bc5f-4f89f3e79528",
"db_language_code": "sample string 7",
"db_title_id": "6558d0de-98c2-430b-afe2-c3108ea91d17",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-28T15:43:32.4221365+00:00",
"create_date": "2026-07-28T15:43:32.4221365+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-07-28T15:43:32.4221365+00:00"
}