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": "2bb2bd2e-a664-4b96-b881-2697662935be",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "f4a09969-6971-49ec-b137-6bfe2958c67a",
"company_code": "sample string 5",
"company": {
"id": "ab789fdd-14df-4884-8226-d95474b2cd72",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-24T08:24:00.7477701+00:00",
"sales_territory_id": "32fa76ba-5d67-4fb8-a308-64b0adcf2b7d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "06554644-d348-4c21-8a33-3a43fcfa4ef2",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "018eb58b-9ae0-4980-abe8-8a136e89d0a4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "76296a83-6f10-47f1-a185-2fb42ed32cd3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ee8d550a-6153-4064-b681-ef06e52b9281",
"db_currency_id": "3a28b2b5-ba49-4f04-864c-28ea097a7d59",
"db_language_id": "247a2f61-21aa-4721-8631-73c32bb741ba",
"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-01-24T08:24:00.7477701+00:00"
},
"modified_dateutc": "2026-01-24T08:24:00.7477701+00:00"
},
"marketing_segment_id": "620ca13f-58ef-4329-90a5-6015ab914a1d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "309bac89-f7a5-44c6-b0ee-6f9f2d65422e",
"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": "8bf3a3b1-57be-45ee-b6df-f4da8e6b7064",
"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": "f28eb316-f15d-4e51-bc23-0a6591410033",
"db_country_code": "sample string 28",
"feelist_id": "843d6d1f-59d8-44e3-ac2f-76409ef238e1",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "4ca29d8b-9bcd-4d62-99e6-88ee48b9ab27",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "81478f91-ad36-4139-ac75-18991b6e811d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-24T08:24:00.7477701+00:00",
"db_currency_id": "40f5c4ab-8f31-4294-a4ea-56136b202e99",
"db_currency_code": "sample string 10"
},
"company_type_id": "8a985091-5293-4605-a685-840f65135869",
"company_type_name": "sample string 32",
"company_type": {
"id": "f268fd2e-4686-4274-a246-b34ba7b507c4",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3b06fd8c-3c24-4e8f-9961-b81ec1669dc7",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e78984ef-8d7b-4434-96e1-e533aef0ca9e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "de1b28bb-25d9-4a06-8d77-50a28d625d29",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a2a8324f-77d8-4385-badc-42d5d1ab490b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2c60ec8d-473c-4771-8897-0f8d61fb6277",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-24T08:24:00.7477701+00:00"
},
"company_sector_id": "5f354a53-fab2-4d78-a921-8ae6c10e8498",
"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": "cf4c84c0-d28a-4b89-b585-83ab364958cc",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "9655e818-6e69-4f04-b755-031b5ef969ec",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "38f304b5-cd17-417e-8e5b-e4915050e866",
"account_manager_user_code": "sample string 56",
"company_status_id": "04de30aa-403b-4108-a84f-3ab9cebdc378",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-24T08:24:00.7477701+00:00",
"id2": 60
},
"db_language_id": "bc8fbb52-f3ee-4a56-8317-3cc854840b42",
"db_language_code": "sample string 7",
"db_title_id": "786bad2a-c771-4c96-aad0-30b10edcf542",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-24T08:24:00.7477701+00:00",
"create_date": "2026-01-24T08:24:00.7477701+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-01-24T08:24:00.7477701+00:00"
}