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": "47cecfe1-8efe-4484-9f59-d54c9c30083f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "af432277-369d-4b6d-840c-21137530c522",
"company_code": "sample string 5",
"company": {
"id": "37284327-a57d-4bb7-8572-c9721340d805",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-14T23:51:03.9751408+00:00",
"sales_territory_id": "9f902c25-c33c-427c-aca9-6e1f24e72f1a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c944e5bf-8922-47f7-b38b-85e43f9c8457",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a8da36c0-ecd6-4fe5-a711-94808a6cab38",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4e9e59a2-53b5-4cbc-aa39-470039e7f3e6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "79186a75-07ec-4833-915b-0660f91ff74b",
"db_currency_id": "d4c58073-8293-456d-a1f0-905eaa0f62f8",
"db_language_id": "4ec08b9e-15b0-4253-bfef-9d02d8035ae0",
"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-11-14T23:51:03.9751408+00:00"
},
"modified_dateutc": "2026-11-14T23:51:03.9751408+00:00"
},
"marketing_segment_id": "6089046a-a64f-4b29-8cac-151d04c40f6b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "fdc348a5-1899-45f2-a13d-5c4dc2a79669",
"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": "67a1edf0-e96c-4daa-b06b-fcce3aeaf376",
"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": "9e86a111-3972-4611-b566-7e628c2ac5a4",
"db_country_code": "sample string 28",
"feelist_id": "0e9f9dbc-8b44-4687-981a-b8ce3992513e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "82afa9c2-3743-4644-9d94-e4e5b99fe271",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "19a3c9fe-32b9-4ff5-aa25-3f03dc137293",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-14T23:51:03.9751408+00:00",
"db_currency_id": "96774495-380f-48e3-92aa-38aa170a747d",
"db_currency_code": "sample string 10"
},
"company_type_id": "7a80ece6-bb28-4e01-a565-8f13866fc13d",
"company_type_name": "sample string 32",
"company_type": {
"id": "655112d9-18e7-4e2d-a29a-fcd920a98d3f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f8960b5f-f54f-435b-a815-5234d35ca969",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9b656f3c-7fa0-4c16-8ac9-50d4cc0ad534",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "00e60d04-07cb-45d3-b29b-87050959bc62",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e7172675-8571-43fe-b688-6e13feef9166",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "af8772c2-e09f-4111-acac-38da7291279a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-14T23:51:03.9751408+00:00"
},
"company_sector_id": "38c4b0fb-5bd0-470f-86cf-0298b11bd7b2",
"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": "6e62772a-b7e0-438f-9046-8466917671f0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d8c0f2ad-210b-4e4b-8df4-6d8583073785",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "5f3d5b1b-8511-4975-b871-f8362e7b4a7e",
"account_manager_user_code": "sample string 56",
"company_status_id": "aa897443-2ae3-49f9-b998-3d294c0c66a9",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-14T23:51:03.9751408+00:00",
"id2": 60
},
"db_language_id": "23ee6e47-4756-476c-8357-2a56393d6d08",
"db_language_code": "sample string 7",
"db_title_id": "a2be5e29-f735-4c8e-9543-85dfeccbef52",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-14T23:51:03.9751408+00:00",
"create_date": "2026-11-14T23:51:03.9751408+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-11-14T23:51:03.9751408+00:00"
}