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": "86605b2d-c9f4-4ea9-92e8-9b8ace0b6d97",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "86da7845-2eef-4a32-a0f7-ea75bc5362e7",
"company_code": "sample string 5",
"company": {
"id": "784cadde-8654-4ab6-8678-aa0656e66631",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-27T17:53:44.9749274+00:00",
"sales_territory_id": "4ef777a2-93ad-439a-addf-e7e5da5abf12",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "27800a12-c787-4b78-ad6a-87103b801645",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "079e1d29-2620-4379-ac5c-3d589da2ca1a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d87a6651-ec4e-4f0e-8aed-7f6a0b69fa08",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "93c73010-7bdd-4657-b8ae-bfb5205c6d40",
"db_currency_id": "3aa2d137-c01c-479b-bfb6-918dba84f04f",
"db_language_id": "51269389-b4a8-4ca5-a829-a21554e0a112",
"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": "2025-10-27T17:53:44.9749274+00:00"
},
"modified_dateutc": "2025-10-27T17:53:44.9749274+00:00"
},
"marketing_segment_id": "b78a29ff-c9a4-4b1e-a66d-170effcd2277",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "2c44df3c-5b8c-4efc-953b-18b338fd533d",
"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": "8ca9ce69-57ff-47d8-b3c4-75842eee4783",
"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": "cfce5757-3926-4fde-85ad-919419fae4ec",
"db_country_code": "sample string 28",
"feelist_id": "a4262f1b-af83-4c29-8447-71d481fc4d7c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d5471f84-c341-497a-bed3-c47883c7e83c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "76bb6595-1817-4134-bbd9-390a1e94382d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-27T17:53:44.9749274+00:00",
"db_currency_id": "6ab47918-a408-411a-af75-e3babf7f471f",
"db_currency_code": "sample string 10"
},
"company_type_id": "928ffad8-130b-4a2b-a0da-74633b349e3a",
"company_type_name": "sample string 32",
"company_type": {
"id": "57f0f4ed-467f-4cbb-9ff2-25e6a22318b0",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "792bf36e-8d26-47c8-84cf-9ed68404c3e9",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ff5fb396-84b6-49ae-b824-37484c293102",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "bf8d376c-3c66-4433-b30d-469719cfdf1d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "85be06b9-7450-43f9-9557-50a3402dfb17",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "74dac9bb-6bca-472f-8cad-04de82764b9c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-27T17:53:44.9749274+00:00"
},
"company_sector_id": "e02755e2-9e3f-4920-978b-2d731441c4d0",
"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": "dd99dac9-3b0a-4df5-a264-cb972a13998f",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e5f63058-359b-4d50-8d5f-5325e4d7b778",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "47b2d9ac-9c3b-417e-b45d-6da1338a3a7f",
"account_manager_user_code": "sample string 56",
"company_status_id": "73ebcf5c-8722-47e5-a091-d260aea34814",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-27T17:53:44.9749274+00:00",
"id2": 60
},
"db_language_id": "68f3bee2-f7b5-43c1-8a46-8acd7bfef4b2",
"db_language_code": "sample string 7",
"db_title_id": "09a17679-bd9a-47f6-a58b-a2544e838f62",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-27T17:53:44.9749274+00:00",
"create_date": "2025-10-27T17:53:44.9749274+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": "2025-10-27T17:53:44.9749274+00:00"
}