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": "19dba1b4-79c6-44af-9b20-e1fba6512ff1",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c687cb4c-1ddc-40c4-94be-398099864170",
"company_code": "sample string 5",
"company": {
"id": "7c0eaebf-af26-47df-b761-a1521170ec7f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-29T11:54:46.9171163+00:00",
"sales_territory_id": "a6e6cba0-f243-4a44-83a1-b5886e310440",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "411f5caa-c862-48f1-84a9-b1d6f37094f0",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bb02ee00-dfc8-4449-8daf-b1516bdd6f7c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "13995ac2-0b1f-4e43-bd54-87a4131bde57",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73161d90-f3f3-4398-bd69-a092a30f350c",
"db_currency_id": "08b51f35-77db-42e7-a7a2-960dd6ac14c8",
"db_language_id": "b0fad00d-a08e-47ae-98f7-bf2fdfa26187",
"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-29T11:54:46.9171163+00:00"
},
"modified_dateutc": "2026-09-29T11:54:46.9171163+00:00"
},
"marketing_segment_id": "f97f413c-c104-43e2-87bd-ec9d8005c61b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "1d20356c-0d23-4a37-a46a-f01f5e59199a",
"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": "13d74191-4ac7-42ca-8548-1558d2e53b16",
"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": "c59842fb-6991-4dcb-bfd1-d334a8fe20ce",
"db_country_code": "sample string 28",
"feelist_id": "57f6dee6-b9e9-4069-80d0-c31e54ea47f7",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "7b744517-9467-463b-949e-7e89a7d2199e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "77e9c5ed-4cee-47ff-b1d8-f95517bac48e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-29T11:54:46.9171163+00:00",
"db_currency_id": "666378e7-2315-4be4-8a97-57ba06a3d4f6",
"db_currency_code": "sample string 10"
},
"company_type_id": "1b55ea5d-843b-4365-8b37-c571d3f9a347",
"company_type_name": "sample string 32",
"company_type": {
"id": "44661658-648b-4945-8c07-19f84a2b0ab1",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "77773c29-47f3-4ace-9f22-dd1214f693bc",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9e8d0007-670d-481a-9ae0-a61c4c47078d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "bae1a2cc-fd9e-4195-8521-5780a7ad8f4f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "d32d7ec2-8a2a-4ae6-b920-e5b4066a1aa0",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4b446a9d-5d04-4019-90bf-4af539ec14b5",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-29T11:54:46.9171163+00:00"
},
"company_sector_id": "7539e322-9cb7-4603-8b82-9b22a2bbce60",
"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": "22163dc0-0153-4b78-899e-ca37518415b7",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e52d46bd-c355-4f4f-8564-a861143647c5",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "86617e49-70f5-4981-a20f-499b652c2bf1",
"account_manager_user_code": "sample string 56",
"company_status_id": "ad4fed4d-fda0-494f-90ab-758153ca34b4",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-29T11:54:46.9171163+00:00",
"id2": 60
},
"db_language_id": "4862d120-e9f6-450c-a08a-73eeab719bcc",
"db_language_code": "sample string 7",
"db_title_id": "d1e3b860-0ed6-4938-813b-cae64b22bfc2",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-29T11:54:46.9171163+00:00",
"create_date": "2026-09-29T11:54:46.9171163+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-29T11:54:46.9171163+00:00"
}