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": "9250baaf-b479-4bf6-a95e-349bfc832dad",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "212e3c93-f5a7-4aec-be05-f729f4e4b973",
"company_code": "sample string 5",
"company": {
"id": "4ea997be-d718-42b3-a9d1-318eff3eec2d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-01T08:18:51.2234056+00:00",
"sales_territory_id": "5d2372bb-945e-4f7e-b072-9354541c4aae",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0c17ee26-9274-4910-81b7-7470bab6fb18",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cff818b0-36c8-418f-af74-acdce8c87c3d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "24f808e9-4849-4fd0-86f6-5017316bc811",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d13c1826-8555-4020-9649-be8ab9633df0",
"db_currency_id": "5ff60375-f640-461b-8d2d-5ade103ae13a",
"db_language_id": "15e7f5ac-c838-4323-a84b-2826ea13f1f4",
"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-09-01T08:18:51.2234056+00:00"
},
"modified_dateutc": "2026-09-01T08:18:51.2234056+00:00"
},
"marketing_segment_id": "4a29964b-b403-4493-8f1a-c0f1a0d8d9db",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e210bf12-a806-4095-a7f2-c8f790a0135d",
"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": "bff4ae1b-0c0a-4b0c-b2b3-939f4a05f2c1",
"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": "e6e76b8f-e8a5-4233-95f2-321c382a2580",
"db_country_code": "sample string 28",
"feelist_id": "931087a9-3d25-4ceb-a50d-d8d4c1312f03",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "0188e081-a646-4242-ac0a-b059d888dd26",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "229c7984-9515-4a17-b71f-1bb774ea6012",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-01T08:18:51.2390275+00:00",
"db_currency_id": "34c99e74-6bf5-40ae-936a-ff38498f0ab9",
"db_currency_code": "sample string 10"
},
"company_type_id": "eec706e2-6c39-4dba-a224-320d47301f4a",
"company_type_name": "sample string 32",
"company_type": {
"id": "13665e6a-4038-41e4-a6c7-7e8344458463",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9a937288-87ed-4aba-8921-c2b7c9aaab7f",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a7dea5f7-45ee-4bce-aba4-69f46ddcd6af",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6793208b-c630-46b3-bd02-e4a7af1b75e4",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "fe372579-e41e-4143-b729-d0657aabdb31",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "17391d7c-e109-4b09-b23b-874e898bef53",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-01T08:18:51.2390275+00:00"
},
"company_sector_id": "b4977d0a-ba3e-466a-9b22-b171906b6218",
"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": "e0289251-d9fb-46da-8f88-14bab98a8737",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "54891245-3b64-4ee5-bffa-76f74a83ede4",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "bb19abff-fa68-4f10-9676-03d7b923fed5",
"account_manager_user_code": "sample string 56",
"company_status_id": "05ab29d3-c7e9-4c82-a93a-c222a227eb9a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-01T08:18:51.2390275+00:00",
"id2": 60
},
"db_language_id": "d503db13-3683-4b92-bddc-66c71f4f71b2",
"db_language_code": "sample string 7",
"db_title_id": "4decf814-9249-4246-a004-8a8bbcb48587",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-01T08:18:51.2390275+00:00",
"create_date": "2026-09-01T08:18:51.2390275+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-09-01T08:18:51.2390275+00:00"
}