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": "aed32b15-aa7b-4198-ac3a-9be58e175bc0",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "ee0e47c3-65ef-4b75-94a7-34b2a43e24e1",
"company_code": "sample string 5",
"company": {
"id": "ee9fc8a2-fa47-4702-a6e5-c156af24c9c5",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-29T09:46:49.1316808+00:00",
"sales_territory_id": "89bcfa86-e5b5-4072-993e-ec983a177646",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c9288d07-8a4b-4c95-b1c6-7081b6efd8e9",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "41fa900c-c0bb-4fb7-8b3f-336ca8dddbb0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2c4093b4-259d-4e24-9cc6-11fb1d6fd93f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1be206dd-9778-423b-aeb2-c9e2e701d9de",
"db_currency_id": "24ced2bb-d69d-4f1a-96c8-156079685648",
"db_language_id": "7705bf0a-c5fa-4931-81b6-d6f1c7ceef8a",
"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-09-29T09:46:49.1316808+00:00"
},
"modified_dateutc": "2026-09-29T09:46:49.1316808+00:00"
},
"marketing_segment_id": "391267a6-577e-4dc3-baf0-715f9efcc803",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "db8ac7b2-5f86-406a-943a-67a5406c05be",
"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": "d949ad98-9a4f-4b37-b0be-a6cef952cc01",
"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": "7444de9c-52e6-4e6f-88a7-49c3f0762794",
"db_country_code": "sample string 28",
"feelist_id": "8d34cc3d-94ca-4fb5-82bb-b30f6fe58c3e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "86875ee0-4581-4bde-b136-ff4436de70a5",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "2b0923b3-9458-44e1-8787-afd4d1f64b0d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-29T09:46:49.1316808+00:00",
"db_currency_id": "b57509ab-1ebe-4a37-930f-92f81e971871",
"db_currency_code": "sample string 10"
},
"company_type_id": "57d32fc9-c71e-41c6-9b90-066c50614d1d",
"company_type_name": "sample string 32",
"company_type": {
"id": "1cb7ae50-bb4b-4a9f-a9b3-2a7e7ff4e9e1",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "13bf34bf-4e50-43db-b572-cf14f110a95a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "cf7dc097-238c-4be4-9f2a-4322bafa207d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5a42a233-12ac-4972-a767-86cba1c406ff",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "aee87ce5-f04c-4574-b935-3b27461e27fd",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "bff78ae6-de75-4c03-9e1b-22751d85502e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-29T09:46:49.1316808+00:00"
},
"company_sector_id": "c3a8062c-d312-43e0-b225-a677cd50207d",
"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": "1dd06285-6c6f-410f-a75c-29354be04ad0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2504e54a-29f3-4585-bf0c-37e9be6158ed",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b15274b8-fc8d-4a02-b7b2-4d1c20ac323f",
"account_manager_user_code": "sample string 56",
"company_status_id": "690e6007-3296-433d-99fe-c1527e0179dd",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-29T09:46:49.1316808+00:00",
"id2": 60
},
"db_language_id": "0092e036-7771-46d7-abba-80db4e34e594",
"db_language_code": "sample string 7",
"db_title_id": "69b3e494-33d1-4de8-ac7b-35d87b1b825e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-29T09:46:49.1316808+00:00",
"create_date": "2026-09-29T09:46:49.1316808+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-09-29T09:46:49.1316808+00:00"
}