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": "82eee813-6a35-41e1-8787-29ff032d2d9f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d1ba5d7c-0592-49f2-8050-3731f8f24d5c",
"company_code": "sample string 5",
"company": {
"id": "74a1994d-be96-412d-9780-dc10f3398860",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-09-18T13:50:05.8603139+00:00",
"sales_territory_id": "c58eb848-57da-4ccd-ac97-7bbc773d2533",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "8c5c9657-a7d4-460c-9040-1ad7038150e8",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "151ae7b7-6726-4e71-84ec-63505c19eb79",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c7804ea7-16b4-4acd-b1ad-0684be1bbc85",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1844fffc-31e5-474f-b5da-0a6ea1022a11",
"db_currency_id": "0b5380b9-3531-457a-a988-46132f805b5f",
"db_language_id": "d9928598-fc28-4e1e-93e0-6ef57515735c",
"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": "2025-09-18T13:50:05.8603139+00:00"
},
"modified_dateutc": "2025-09-18T13:50:05.8603139+00:00"
},
"marketing_segment_id": "99702105-a99e-4f36-a50a-0393ee2b5c67",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "0ddb31cb-ae1c-40b8-a664-935fc4be14bf",
"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": "820819d4-c791-439d-9ac4-18779e1dddd2",
"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": "f3a2d11c-3749-446d-a2cf-3e14d0da0b5d",
"db_country_code": "sample string 28",
"feelist_id": "c2e6c4c1-4058-40fd-9b4f-aeac23287aef",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d95b8dec-33c3-4b96-bb54-995b8a95ae7a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c81bdea0-b39c-4266-b362-0ad37b0d47c6",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-09-18T13:50:05.8603139+00:00",
"db_currency_id": "7149fbf0-f9f5-4686-a0e1-6ff4937b9f35",
"db_currency_code": "sample string 10"
},
"company_type_id": "ef924e8d-3814-46c8-a9fa-2a83832f13cc",
"company_type_name": "sample string 32",
"company_type": {
"id": "d33433cf-d7f1-4527-9039-dee8b49f1e68",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fe92ff40-0240-41f8-8a36-42735b246f2e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b95e49cb-e0e8-45ca-943b-17d16c1a7147",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "1daf25ac-5633-4903-920c-e018698f5ea1",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "d91b8084-d284-4236-bd5d-618023204ce4",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "dd32bb91-b47e-4706-9520-0a3bf20f8927",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-09-18T13:50:05.8603139+00:00"
},
"company_sector_id": "8de8966d-d0c4-41ce-8c7f-cdb9a49f574c",
"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": "52ab726e-d040-413b-a705-49a2b0d9d0c7",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "ea2374d7-a52a-4056-971e-c611bc3ee01f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "cecd1eb9-e213-46bc-b50d-bc2e7f667c07",
"account_manager_user_code": "sample string 56",
"company_status_id": "ad5b0954-c5c0-43e4-b776-10f903b02ae3",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-09-18T13:50:05.8603139+00:00",
"id2": 60
},
"db_language_id": "02c906b1-c6b6-47e4-b919-492823948c42",
"db_language_code": "sample string 7",
"db_title_id": "fac66e3e-6ae7-4bc2-962f-d3374377f9b4",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-09-18T13:50:05.8603139+00:00",
"create_date": "2025-09-18T13:50:05.8603139+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": "2025-09-18T13:50:05.8603139+00:00"
}