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": "24c7658b-2d22-4c6d-84b7-44169ea4b092",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "efeaf9f5-b2db-4814-9b3c-c621c31d1c25",
"company_code": "sample string 5",
"company": {
"id": "2fb15d0f-2da3-4640-81d0-d8ce003faca2",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-17T13:18:47.7320476+00:00",
"sales_territory_id": "af0c46c9-abf4-48b7-86b1-b2e5e24c1f30",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "52c9d666-c638-4d73-834f-bef8aca0f1e8",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "15abff08-1422-4e6a-b7b2-fe7fd1f63553",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "781f0c6d-6879-47f8-a592-380802f0a8c3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e94a53e0-d7bd-4eaf-9b50-997155aaa845",
"db_currency_id": "63a400b2-21e6-41b3-9c1d-4bf621d94017",
"db_language_id": "ed8b408a-d971-4a2f-b9dc-d56e4b21aa26",
"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-17T13:18:47.7320476+00:00"
},
"modified_dateutc": "2026-02-17T13:18:47.7320476+00:00"
},
"marketing_segment_id": "460f2191-febd-4f3c-8e6b-022969654ccc",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "49ffac84-54cf-4293-9291-8abf34d2ec6c",
"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": "8bef1966-a5d8-41ca-bdd7-5e0260d3bfb0",
"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": "c0e55c5d-e55b-4f8a-8b2c-cbc5e5f98069",
"db_country_code": "sample string 28",
"feelist_id": "151bf7b0-ee11-4778-bc0e-02c5bccfab02",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "9e1e6512-a0ed-40ad-a62f-e69aed529926",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "da131482-938a-41bc-8cbd-8fa54bb3e6ab",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-17T13:18:47.7320476+00:00",
"db_currency_id": "5c5f5a99-83b2-4181-b40c-7fe92f2429be",
"db_currency_code": "sample string 10"
},
"company_type_id": "19f92dcd-773d-4178-82a8-968fc63ef6c2",
"company_type_name": "sample string 32",
"company_type": {
"id": "6e272aaa-818b-468c-afa3-2ef9cbd484ee",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1b31e66e-2450-4835-96ed-6221b27bd89a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "4d6e74f2-2373-411e-81b6-db66771d537e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c9fa006e-f1b2-4cbf-b2c3-81479a490526",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "5dcf8dae-6624-400e-abc3-1d065f3fdfec",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "cde8c503-eb33-41c2-826e-9d5eedf41eba",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-17T13:18:47.7320476+00:00"
},
"company_sector_id": "a9d50e2b-95c3-44fa-8a95-8284e8277bb2",
"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": "2504802c-a759-444a-8fc3-2a137651ed27",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "652228af-8067-4915-b223-489811c5b4ce",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9fb71379-f179-46ed-82c1-df5667988c44",
"account_manager_user_code": "sample string 56",
"company_status_id": "b3379f52-389b-41c8-80c1-fa0498d9f5fb",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-17T13:18:47.7320476+00:00",
"id2": 60
},
"db_language_id": "a2d92881-c8db-4922-b561-ef241f31bb3a",
"db_language_code": "sample string 7",
"db_title_id": "78a2e919-dc7d-467b-9f95-61f09695ffae",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-17T13:18:47.7320476+00:00",
"create_date": "2026-02-17T13:18:47.7320476+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-17T13:18:47.7320476+00:00"
}