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": "1f8657ce-6904-42cb-bdb4-4ae2e7822559",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "627cb80c-d341-45e7-a6d2-8e6a08798998",
"company_code": "sample string 5",
"company": {
"id": "c3ae6569-5ff8-45d7-83d2-46b65e765331",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-04T10:58:16.8930151+00:00",
"sales_territory_id": "abc1a4c7-721c-4790-8e8f-9f26add9bc50",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a7cbc1b6-6036-4394-a447-3cb7e2429006",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a5b47526-fc4c-45c6-8367-4fa04266855b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1bba1648-bafc-4c37-9c53-f32cbdcb08c5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "068e27ad-1281-45b3-a9d6-f3a77d1ff147",
"db_currency_id": "d34453bc-92ec-454a-9779-6985990eeaee",
"db_language_id": "1704926f-d42a-4a79-a156-d5a881101bd2",
"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-02-04T10:58:16.8930151+00:00"
},
"modified_dateutc": "2026-02-04T10:58:16.8930151+00:00"
},
"marketing_segment_id": "d2330a60-6f29-482a-a390-34e18481c136",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "42ed2d4b-5f1c-427a-b4b0-6900ebfad512",
"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": "311b7ac2-7b1d-4a89-a976-9b3b2f344348",
"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": "cc02e2e3-8d2a-4ac9-9c76-6c54db774f61",
"db_country_code": "sample string 28",
"feelist_id": "7b611977-40ac-4583-897e-86e5c1d5ad03",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ce6dfd18-f5cd-4a25-9282-de2624ffc419",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "bff737d4-975c-4d59-90b0-dac917e84150",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-04T10:58:16.8930151+00:00",
"db_currency_id": "a93bd3c3-5c3d-4443-9a48-05ef6c8f2bf8",
"db_currency_code": "sample string 10"
},
"company_type_id": "a1cc61c9-8e90-4dbf-a053-a7c8571028de",
"company_type_name": "sample string 32",
"company_type": {
"id": "e1dfef9f-7720-487c-b535-26fc39ac7dea",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e7a796b8-7019-44a5-b7e6-8e41cd1bde78",
"sales_organization_code": "sample string 5"
},
"db_language_id": "19228b2e-f464-4480-8f04-c4707b1bb9b3",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "29c3366e-ca1f-41e1-9564-6f046d9c8b0d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "793c4289-2c02-4824-9811-aee5ed62c8cf",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9fb124c1-93dc-4dad-a371-871584cac702",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-04T10:58:16.8930151+00:00"
},
"company_sector_id": "a79e8f11-de23-4e99-9b62-275ee15d5ca5",
"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": "4140dcd7-a81d-4863-8615-fc46cbfa754c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "579cbc4a-95b8-4f90-9420-c3f6f8850e84",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a7cdc32a-8782-41ba-8325-069977225360",
"account_manager_user_code": "sample string 56",
"company_status_id": "ed713ed8-64b2-4f3d-9d57-f16b56684a31",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-04T10:58:16.9086176+00:00",
"id2": 60
},
"db_language_id": "37690caf-d463-43ff-aa0a-58e95b28ed31",
"db_language_code": "sample string 7",
"db_title_id": "0d9983b1-fa7d-4c86-9b97-636f00f8619b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-04T10:58:16.9086176+00:00",
"create_date": "2026-02-04T10:58:16.9086176+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-02-04T10:58:16.9086176+00:00"
}