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": "b4a4d01c-1c0b-40fd-b325-3602efbac320",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d00b694f-eeef-48bf-acce-8f6da04c3887",
"company_code": "sample string 5",
"company": {
"id": "51b93ccc-98f5-4308-ad27-80f7b23b460e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-20T06:42:10.8838181+00:00",
"sales_territory_id": "23e107e8-d940-4c8d-acad-e83d7fa33d16",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "de306342-01bf-4903-a553-669f4cfc5543",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fcdb50f4-86e1-4b60-a858-9249de15170b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e9b9a862-64c5-410b-bb63-8e51825377c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c0e6e7cb-0338-4fd5-ba58-71a185f1723d",
"db_currency_id": "f69743fb-a228-4dab-a4e5-a550c222ed1c",
"db_language_id": "e41a32f5-45ff-45c4-acfc-5f83aa6f3f19",
"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-08-20T06:42:10.8838181+00:00"
},
"modified_dateutc": "2026-08-20T06:42:10.8838181+00:00"
},
"marketing_segment_id": "b808f0d5-69cf-4f7f-9429-0286b20e518b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "08f0f5ce-cf5a-433c-9eff-815c1f4af7dd",
"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": "5d3cbede-850d-43c4-a2e9-be72e434f30f",
"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": "3550433f-de2f-4f56-9d84-d4c677911f7b",
"db_country_code": "sample string 28",
"feelist_id": "a7f6392d-7187-4738-b16d-bcf85b3fa4b2",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5c4adbfc-aaf5-4cad-b133-8fa36301288f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "fa6f6698-96dd-49c9-9906-288acccbb612",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-20T06:42:10.8838181+00:00",
"db_currency_id": "5a687c54-f58a-4dcc-a912-be8ec93948fc",
"db_currency_code": "sample string 10"
},
"company_type_id": "7ba516bb-70f9-40e9-95e0-0a64e7510fd6",
"company_type_name": "sample string 32",
"company_type": {
"id": "5cf5eab8-dc5c-486f-a132-f546c7ceac37",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0d45624a-6298-4c93-86b2-b8ee9d9a1c04",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0f3da551-27fc-4d3c-946f-c1b5f793f326",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3d442846-0fd1-47a4-b5ba-977d95bc757a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a650d7e4-07a9-4444-91f7-9e1063f87aba",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "1274434b-cc42-4f48-a898-5c7ba63d1b82",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-20T06:42:10.8994389+00:00"
},
"company_sector_id": "54f89b33-06b6-434e-abbf-b52dbf2017b4",
"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": "04cb8386-9e12-489a-8850-60822e0bce62",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "4b251f0e-023c-47ca-a4f6-10aab50f66c9",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "68521d3a-2a42-445f-b757-3b45723a478b",
"account_manager_user_code": "sample string 56",
"company_status_id": "8eca7f7b-d527-47d2-829c-934c7780d1c2",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-20T06:42:10.8994389+00:00",
"id2": 60
},
"db_language_id": "2d396ec8-1add-428d-9c8b-9aa33e4d7281",
"db_language_code": "sample string 7",
"db_title_id": "1f044f47-996f-451b-90d3-be86361cbd9d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-20T06:42:10.8994389+00:00",
"create_date": "2026-08-20T06:42:10.8994389+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-08-20T06:42:10.8994389+00:00"
}