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": "5ee196fe-75c5-483a-8a9d-95312a81d713",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "182b1a08-a1f5-496a-ae3d-cc62ad95e731",
"company_code": "sample string 5",
"company": {
"id": "9145a50a-b87c-410c-ba3f-c674e05231dc",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-03T14:28:06.0423559+00:00",
"sales_territory_id": "3447d880-5dcd-4200-9fc5-1400fed89a4d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "39a37c3f-d2bf-4797-91dc-e92167fe3097",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "df0b8e6d-5487-4253-82f4-6f6cc91390d6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "57ef74e4-6833-4a50-9478-f882dd5bb4b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "81c36efe-4285-432e-afdb-eb3bdb8864c0",
"db_currency_id": "6399be85-9b21-4353-ad91-9c69e122110c",
"db_language_id": "c8b0e04b-ecc2-4c68-b754-9e6845585aea",
"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-10-03T14:28:06.0549682+00:00"
},
"modified_dateutc": "2026-10-03T14:28:06.0549682+00:00"
},
"marketing_segment_id": "771ea634-1b44-42d2-8341-b9c90c8d463f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "bfb6a39c-255e-465f-bec4-2b9e1eb3be84",
"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": "9aea0c75-eda8-40b2-8a5f-4ce53402dbfc",
"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": "19fb68ac-53ee-441c-ac44-d299f5d06289",
"db_country_code": "sample string 28",
"feelist_id": "9f75c41b-ce1e-4500-8466-9a38153dfe6e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "89c7c98b-cbb1-460a-bf05-46417d2e3633",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "90e894b3-9623-426d-b688-0d744624011e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-03T14:28:06.0549682+00:00",
"db_currency_id": "bd593f2d-5d1c-48b6-b0e9-139c7c94b3ed",
"db_currency_code": "sample string 10"
},
"company_type_id": "cec465df-fb48-4495-912a-834b00088136",
"company_type_name": "sample string 32",
"company_type": {
"id": "488c53d5-56a1-431b-832c-d395e40020aa",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "74c0aca0-67b2-47e9-a9ef-57ae1e9d11de",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b8b32555-3a5c-4b7b-83b4-dbcb670252ca",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e47b65ed-9287-4db6-86e7-262d7155329e",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "41b7bb55-89b8-4bbc-bc3e-9b1f0765d53f",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2371f569-ba3a-4cfc-9e9d-f518f8cd98a1",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-03T14:28:06.0549682+00:00"
},
"company_sector_id": "fa0b0d80-aedd-473d-bc24-a847b37b7c23",
"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": "10364e16-2f26-44ee-a578-dc8f455df812",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "0455aef6-dbcd-4599-bbb6-630160e7e036",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "3857bf82-b006-478b-9f33-84f58186bb2e",
"account_manager_user_code": "sample string 56",
"company_status_id": "5b9b5eb7-ab83-47c7-b011-e5f2bbba484a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-03T14:28:06.0707806+00:00",
"id2": 60
},
"db_language_id": "e809da5c-fd05-4eac-8fd5-dd14865b273e",
"db_language_code": "sample string 7",
"db_title_id": "59724bc2-3588-44c1-a8b0-e0467b94423e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-03T14:28:06.0707806+00:00",
"create_date": "2026-10-03T14:28:06.0707806+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-10-03T14:28:06.0707806+00:00"
}