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": "ba3f93d2-94a2-4556-9d70-ce547be77248",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "9837bf7b-a0fb-456e-8cdc-311b3af98c16",
"company_code": "sample string 5",
"company": {
"id": "271a0f7e-779c-460b-88a0-20d2775e38fc",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-19T13:23:59.9858188+00:00",
"sales_territory_id": "2463ccc1-a1ef-4e80-a94a-7b49c19baed9",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "32489249-0d8d-459b-91f3-8647ccf27e72",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a0ee4871-6d42-4fdd-96f2-44d2266bf431",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "64bf3b32-ec35-44af-a903-ecac54a794cc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fc591c06-a54b-49c2-b1fa-3a17bc9156be",
"db_currency_id": "a3482017-5e04-49b4-9386-8f6822dac8d0",
"db_language_id": "112c7253-cd81-4eab-bd0a-2af354cbb88d",
"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-19T13:23:59.9858188+00:00"
},
"modified_dateutc": "2026-01-19T13:23:59.9858188+00:00"
},
"marketing_segment_id": "9255b6ba-83d2-44ca-8dad-9fa6365add76",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "5c874b5e-1cf9-418c-8e2d-b5d41fc5f6f0",
"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": "23d9b6cb-5df3-4376-a2e4-48e11d96100e",
"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": "fbca35db-cb41-47ec-ab30-96151b61b075",
"db_country_code": "sample string 28",
"feelist_id": "48b54b0a-afcf-4486-bd85-965d4e98705f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b580fc72-4270-4ab9-ae5c-3c959e4ebbb9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "939a48d6-1172-4298-9290-11b570da65ef",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-19T13:23:59.9858188+00:00",
"db_currency_id": "b8c0693f-f23c-4763-aa4d-78310f7d1e9b",
"db_currency_code": "sample string 10"
},
"company_type_id": "86da28ca-4126-4cff-8de2-91c94c8b37ba",
"company_type_name": "sample string 32",
"company_type": {
"id": "82b640e1-cb84-4bd8-b5cf-d0e8ecb60b9c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d90da380-958f-4257-860e-781f1111f51c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "32715024-e1cd-43bf-b761-14e9d3378389",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3a29becb-1136-42d1-8bf7-e5ca63bb3945",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0e868cc1-b9ff-4278-99fd-7648c8ee2e5e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "47614843-4ff6-4d5f-a5d0-dc9a518b4ace",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-19T13:23:59.9858188+00:00"
},
"company_sector_id": "54b1e17e-5e70-4d8c-a991-798d6c0f8030",
"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": "a057a40d-40d6-472f-840c-a754c51dea43",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "57b88faf-f040-4a78-aebd-edfcf2e0b2b0",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "99f63f08-f4bd-47e9-8c7c-fb0d6cbcd732",
"account_manager_user_code": "sample string 56",
"company_status_id": "80a4eaed-9099-4cd8-acd9-359d365be0f6",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-19T13:23:59.9858188+00:00",
"id2": 60
},
"db_language_id": "e56abb2b-aa18-479f-a8b4-21c88f469794",
"db_language_code": "sample string 7",
"db_title_id": "1a24b5c1-91d5-4e8c-9c78-32d0866d9fa1",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-19T13:23:59.9858188+00:00",
"create_date": "2026-01-19T13:23:59.9858188+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-19T13:23:59.9858188+00:00"
}