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": "5f3db898-1333-449e-b211-3a6221be0ef1",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2c845b21-cc4e-4b37-8117-a114f71a0528",
"company_code": "sample string 5",
"company": {
"id": "376bb8c3-b894-49f5-90d8-4e84e3e1f7f8",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-18T07:18:51.116483+00:00",
"sales_territory_id": "e853ce6b-406a-4327-b313-ba48523ec9e6",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c2794184-5c2f-4a63-9c5b-d508c87f539e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bca0df4b-ba1d-4ba8-bdaa-cbfd6e98d7be",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b950d142-d6b2-4c64-8cb0-67fc8c9e90fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b83edf71-07c9-4ad4-ad14-01e4a47f9263",
"db_currency_id": "9c22ba53-08ae-432c-b656-bf9511448fc7",
"db_language_id": "23c65449-39b8-4888-821c-34be414eb14b",
"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-06-18T07:18:51.116483+00:00"
},
"modified_dateutc": "2026-06-18T07:18:51.116483+00:00"
},
"marketing_segment_id": "0e6a5485-c916-4a87-af08-8c9324ae74a5",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4aa28119-f863-4a30-8a89-2c93a21ca83d",
"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": "945e516f-49b0-4da8-9b6f-c4dff8ff33aa",
"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": "84312b09-364f-4eed-98cf-6b5025f7b9db",
"db_country_code": "sample string 28",
"feelist_id": "8826fe65-dcab-4a3c-bf33-8db75eccc8b6",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "78decac3-89c7-40f9-9599-1302db2e2ae6",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "29931656-19e3-44e3-bf94-a03c54afe00e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-18T07:18:51.116483+00:00",
"db_currency_id": "ad0b09c2-0982-480e-be73-9043d873777b",
"db_currency_code": "sample string 10"
},
"company_type_id": "5eceaa27-2dda-4e8e-ba86-1a2eb3f52e8c",
"company_type_name": "sample string 32",
"company_type": {
"id": "dc5f608d-6207-4ced-9b5c-15720f3f9aeb",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4db67f92-964a-4970-b344-e8df371dcfe8",
"sales_organization_code": "sample string 5"
},
"db_language_id": "8c267ccf-6236-4055-8e9f-b308df7ac33d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "1659fc04-21e5-49e8-b81f-a2a96dc76a17",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f3fdbffb-0c40-4cf7-a24c-e2161f792d0c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "8a52ee2f-3b49-4387-9766-2ebc007b8705",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-18T07:18:51.116483+00:00"
},
"company_sector_id": "a69d68ea-a751-4ea7-8843-44dcc81f1609",
"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": "027430f8-3d6a-44bd-9877-4c2e71584c51",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "6f7d5ef8-f108-4f86-a4ac-19d0733a4d86",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "aca0e116-9927-489f-912b-be5b0aad5482",
"account_manager_user_code": "sample string 56",
"company_status_id": "6f2a2e84-7b13-44ad-b27d-b30573310946",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-18T07:18:51.116483+00:00",
"id2": 60
},
"db_language_id": "0f8be8f2-1c94-4836-b049-8d721974cb9e",
"db_language_code": "sample string 7",
"db_title_id": "bd574c49-760a-406b-a6e3-24adedc52374",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-18T07:18:51.116483+00:00",
"create_date": "2026-06-18T07:18:51.116483+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-06-18T07:18:51.116483+00:00"
}