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": "9a609055-ccd5-4944-b16e-b16a91e6f81c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "993cf431-d9c2-423a-9eb2-c6664b0f2072",
"company_code": "sample string 5",
"company": {
"id": "7a933137-acb2-4573-9aa8-12daa0acd5f3",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-27T16:45:49.1475169+00:00",
"sales_territory_id": "f146d9d5-486f-4a77-9bc1-02f6595f9fc9",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b1e6e60b-efc3-40a1-9e3f-e562000c7e26",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "64aef98c-900d-4354-88fa-8d05e6360cf3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1e02a052-333f-48ae-bba0-ea47e4a56e0f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "852fd901-68dc-4372-b53c-27d5825b052b",
"db_currency_id": "363d68fd-f3c1-4640-9071-b179d9c5b01e",
"db_language_id": "7dc0da43-a978-40fa-b8bb-aa89e6c2226e",
"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-04-27T16:45:49.1475169+00:00"
},
"modified_dateutc": "2026-04-27T16:45:49.1475169+00:00"
},
"marketing_segment_id": "feb26405-afbf-4285-8e30-1e5e177f15b1",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "30755818-ddb8-4d8f-ad35-d779555fa309",
"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": "e16eab63-947a-43bb-89fe-74b8a48a0a42",
"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": "f4e662a2-beee-4584-bfb0-6c7e4e8717f9",
"db_country_code": "sample string 28",
"feelist_id": "3125824d-bfc4-4d74-bb5e-1f64835fc586",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "55bdf6dd-37a7-4cc4-bf42-ce33ff14b6b5",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "31c2a1fd-b28f-4bbf-8aac-1837a80805f9",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-27T16:45:49.1475169+00:00",
"db_currency_id": "001b4653-629c-4727-9217-2e621214dfd1",
"db_currency_code": "sample string 10"
},
"company_type_id": "78ea6f6a-c93c-476d-ba8f-dfef702de497",
"company_type_name": "sample string 32",
"company_type": {
"id": "08cdf386-3264-4433-9b67-16c541f7c816",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6b21de7b-4641-4893-865b-0b7b791e1235",
"sales_organization_code": "sample string 5"
},
"db_language_id": "fbf76f78-a650-4c9a-a036-774baa31a196",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "0f2d56cf-634b-4661-af04-dd6a4a291abb",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f5946327-373b-4bf0-8a81-86f415fb5789",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4de5cdf0-7f26-4bae-81d9-f585b6a1fc6d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-27T16:45:49.1631519+00:00"
},
"company_sector_id": "18e515db-9593-4854-b5bc-dff5aabb74cd",
"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": "160908e0-14bb-446f-8b47-d9ea9c1820b3",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "ef768f74-4cd9-437c-855f-2b6a6a48a7d0",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "eb4872a2-65db-41db-98a7-5f1896c0b272",
"account_manager_user_code": "sample string 56",
"company_status_id": "ff146e40-5e9e-43ed-94fe-b59eefc4bd8f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-27T16:45:49.1631519+00:00",
"id2": 60
},
"db_language_id": "8a4d382c-ceb4-4db9-8f98-ad75e29edcc7",
"db_language_code": "sample string 7",
"db_title_id": "7a800fd3-1542-46b9-a2c4-4f1c0ce04f0b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-27T16:45:49.1631519+00:00",
"create_date": "2026-04-27T16:45:49.1631519+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-04-27T16:45:49.1631519+00:00"
}