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": "67918c22-9178-46b0-8c85-5be2149b70ee",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a5bd7826-eb6a-419a-a6ab-ddd8efb414c8",
"company_code": "sample string 5",
"company": {
"id": "80d379aa-bf2b-4113-885c-79a611d01a29",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-14T21:48:02.3198497+00:00",
"sales_territory_id": "fb91345e-ae2e-4178-bbf2-fe3382eb8e64",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "8d78e175-49dd-4ba4-a964-b8dca71bcd04",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4617de5c-4c0c-443e-8cc4-1444553e251c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e1a436c7-03a9-46cf-b3ff-fad13f5de7a0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "687c74b5-1cbd-41b0-a76c-26da848158d2",
"db_currency_id": "a01a5d54-f9a2-43c2-b0ac-d48bab799ca8",
"db_language_id": "94b04434-7f8d-4925-ad2f-f42b80de27e9",
"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-05-14T21:48:02.3198497+00:00"
},
"modified_dateutc": "2026-05-14T21:48:02.3198497+00:00"
},
"marketing_segment_id": "b5b3cc4c-2f58-48e8-8666-3375071fee6d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d754a839-94de-4790-b0fc-4f4aa4d71b83",
"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": "56276c5e-a1b2-4b50-bfae-953efaad6bad",
"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": "03970adb-f265-492e-8a45-8cd5203166d7",
"db_country_code": "sample string 28",
"feelist_id": "a4ea0626-95fd-4725-b724-ee455183328f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "9702a0b8-db34-4c79-a67f-a1f418eed11f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d2379bd5-cc03-4cdc-977f-c2b146ad1ab4",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-14T21:48:02.3198497+00:00",
"db_currency_id": "3a7e3ca9-4946-4a94-af76-57bcbbf19549",
"db_currency_code": "sample string 10"
},
"company_type_id": "fa601454-91cc-4a69-9853-0b841608e4f1",
"company_type_name": "sample string 32",
"company_type": {
"id": "30bde5a5-1164-4186-8b7d-14d3f5277a61",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5533358f-e914-4041-8db3-efb4e8ba6e41",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5f6fe2db-48b7-4c3f-a0cd-3cae69e42ad4",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "83332825-a794-4714-8bbd-262d446ad73b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "63e953f6-cc72-41ad-937f-fba8d73c23ea",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "859ede65-9945-4fa6-bb94-e2e2a02523ea",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-14T21:48:02.3198497+00:00"
},
"company_sector_id": "006c1169-183a-4da7-81a5-55dfb57b79a8",
"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": "d21c9c04-25f6-44fb-a8bb-609867fa0f02",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d712eb97-cbdb-4d62-88ee-3efba62e9acf",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "0760ef73-6741-49c4-ba0b-86e136b28473",
"account_manager_user_code": "sample string 56",
"company_status_id": "0efa2969-c4ef-4204-a4a1-4c2242030285",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-14T21:48:02.3198497+00:00",
"id2": 60
},
"db_language_id": "081d1039-0422-46f7-8d57-89a9a756d3da",
"db_language_code": "sample string 7",
"db_title_id": "6e387b6e-00c7-4665-8e80-9c3a2ddf7096",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-14T21:48:02.3198497+00:00",
"create_date": "2026-05-14T21:48:02.3198497+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-05-14T21:48:02.3198497+00:00"
}