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": "b5cc3827-9f40-48f3-9f00-b2e918b9776b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "1eeb83a6-6857-4ae1-9f35-408ea8ee4a64",
"company_code": "sample string 5",
"company": {
"id": "784a87ab-c2f5-4a6b-9c85-f22512739e59",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-21T03:26:26.6376685+00:00",
"sales_territory_id": "060ae799-571c-4573-ac8a-a950ac714da9",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ad5a0712-28cb-443c-a796-536de6e7f70a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "45f5b459-3e7d-403d-94a8-8f988d8b0bf9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1976a4cc-31cb-4341-9e0b-70d06b29acb9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "26e7f31f-bdb4-41e4-b767-790ed9d923de",
"db_currency_id": "791c5f46-1cd1-4c3a-be91-38081b08ec5d",
"db_language_id": "cbfd4a60-4e2c-438b-a43c-64c16ce3ce4e",
"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-02-21T03:26:26.6376685+00:00"
},
"modified_dateutc": "2026-02-21T03:26:26.6376685+00:00"
},
"marketing_segment_id": "27234251-fc96-44f4-937d-d7a17616719e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "0a8e7f64-3ebe-4f17-b1d8-decf9a712f7a",
"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": "37ca08dc-73c0-4a59-8b89-8ce1b4f804fe",
"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": "af1a4743-406c-41cc-8f7f-742b03ccee25",
"db_country_code": "sample string 28",
"feelist_id": "62a7be9e-ad61-4d63-8b62-adb98ee92ac9",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "cfcaa0ba-f1a2-4aa6-a169-7c26656f5868",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "4cfc3877-46bb-4b6b-be08-b0569b9bf41d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-21T03:26:26.6376685+00:00",
"db_currency_id": "f4d50329-7c4a-4e9a-9364-ee9ad05e9150",
"db_currency_code": "sample string 10"
},
"company_type_id": "fd2ea355-d774-4e51-9bca-1e17b072fc1c",
"company_type_name": "sample string 32",
"company_type": {
"id": "f6ddaf98-39c4-44dd-8cf6-f1df493136d2",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d15d2769-c105-4937-b101-4ea24e366cac",
"sales_organization_code": "sample string 5"
},
"db_language_id": "4d18870e-7b10-4b72-bb0c-f8f0a41e0e9a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c6754649-cbe5-4276-8ff5-fa976eacd163",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "332e79c8-42d5-4ad3-8857-5faea3c97b06",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "58420efe-16ff-4699-9bfc-5c2fbddda892",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-21T03:26:26.6376685+00:00"
},
"company_sector_id": "68eed938-96e4-4645-820d-87c4663519ad",
"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": "48558957-55e7-4224-bbb0-2f1e086d6acf",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "27f9f349-1082-47b0-8c77-031339432936",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "75e71cb8-34b1-431b-b39b-2ef00c90e05e",
"account_manager_user_code": "sample string 56",
"company_status_id": "ef02592c-2c03-4118-b417-4a3559714416",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-21T03:26:26.6376685+00:00",
"id2": 60
},
"db_language_id": "06b75cc5-bb01-4b6a-9d38-8e87972e0982",
"db_language_code": "sample string 7",
"db_title_id": "dd35fd02-2be4-464e-85a8-b890655dc9c2",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-21T03:26:26.6376685+00:00",
"create_date": "2026-02-21T03:26:26.6376685+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-02-21T03:26:26.6376685+00:00"
}