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": "1bb9d706-03dd-4035-a43e-283231b3457b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c714bd39-94d3-4dc0-b0b7-fd1a99d95efa",
"company_code": "sample string 5",
"company": {
"id": "4054a004-0915-4712-809a-f2b0b6a81dc5",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-08T13:39:50.5739546+00:00",
"sales_territory_id": "a3fa9aea-e66c-4486-aad3-875536217287",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "fd0f4d03-2863-479f-bc38-9f7b71e1fcd0",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ec6af9fd-8dc2-4e48-90b1-9237143e1280",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0f2d0fa0-95a8-4de6-89f6-a4d8732b149a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "796b07c5-4314-45f3-9057-042af05a72b4",
"db_currency_id": "473e0e3c-7e28-4a54-a8a4-cf7741e857cd",
"db_language_id": "d7b43637-7be0-4822-ba9d-1c44b3c606af",
"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-10-08T13:39:50.5739546+00:00"
},
"modified_dateutc": "2026-10-08T13:39:50.5739546+00:00"
},
"marketing_segment_id": "c389025f-efc5-4a53-87b6-d958eb55ed51",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "84d3650c-e0a1-4bb2-8ec6-e805bcf6599b",
"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": "aaadd7f8-7ac9-4207-9346-3daa7898f77b",
"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": "08f79891-1142-4355-82e9-7a53e948bcd0",
"db_country_code": "sample string 28",
"feelist_id": "7b220365-e948-4acb-8baa-29f0c1b9a5f5",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6ec84ceb-ac54-41e6-b025-3a98b7120773",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "07f55bb0-1d8e-4adf-b842-bd84f21b801c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-08T13:39:50.5739546+00:00",
"db_currency_id": "98137373-55dd-4a9d-b00b-a18a38bc587a",
"db_currency_code": "sample string 10"
},
"company_type_id": "e264374c-4329-4d1f-8211-b955623f0d97",
"company_type_name": "sample string 32",
"company_type": {
"id": "ad4bf3c5-dc70-4d6a-b591-ca438f671588",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "06d86922-a892-4afb-93a3-d05d0fd45991",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f89e6c5c-f1de-4e3f-b245-618fe1655c1f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "56ca65b6-27ab-4ce5-86e2-fa2ef73dfc9f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "efcee7be-e764-4625-bba6-84495cf5c564",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "cd0d05af-15ad-4668-b2ab-b6d6e96bda87",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-08T13:39:50.5739546+00:00"
},
"company_sector_id": "226413d4-2736-4f99-a874-6541296aca8c",
"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": "93b4f973-a941-438f-ac89-79a7205852fd",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "9b05d017-6602-4777-b296-5c50d9e12c67",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d43c7a78-2b35-4863-b4e6-bb41284a4c78",
"account_manager_user_code": "sample string 56",
"company_status_id": "00321c52-cdef-4b50-89b6-db28487e015d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-08T13:39:50.5929995+00:00",
"id2": 60
},
"db_language_id": "c2f4e4ce-aab5-48a5-b6ac-3624931b108d",
"db_language_code": "sample string 7",
"db_title_id": "e6f5cbeb-8050-490b-9c2f-d9622a7e2f7a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-08T13:39:50.5929995+00:00",
"create_date": "2026-10-08T13:39:50.5929995+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-10-08T13:39:50.5929995+00:00"
}