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": "b31e8c3c-f009-4843-a8a6-931fb81a7b82",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "17a2177a-36c8-4b3a-bc61-ea8547bbfc6d",
"company_code": "sample string 5",
"company": {
"id": "be993f1e-02ef-4c88-bef5-672979637a7a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-14T21:06:53.0911251+00:00",
"sales_territory_id": "4c37a220-ffda-4ca8-8858-2019ff71efcb",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "fd722762-abf4-4c5a-b4a0-3007744c8804",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b053e59f-62f3-439f-8447-82c0b9bea8e0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "98865305-2b18-4d63-9407-78d99dd96bc6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "460b9978-d01c-4f3f-bcc0-ae6a03b1015e",
"db_currency_id": "45418b0c-a289-4080-a68d-9e2eb9efb73d",
"db_language_id": "ef65ba3f-4296-4b4b-b873-076e8b6042b2",
"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-08-14T21:06:53.1067423+00:00"
},
"modified_dateutc": "2026-08-14T21:06:53.1067423+00:00"
},
"marketing_segment_id": "76b0211d-49dc-40e3-bce9-a7ef1e5ae209",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "44d076be-42ce-4f99-a90a-4fc8083b1080",
"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": "26875da9-53d8-4f76-a13d-e962c3588783",
"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": "6fa8e4af-2a86-4db8-a8d5-fafaa21ee71c",
"db_country_code": "sample string 28",
"feelist_id": "cc0ed2a4-bb19-43db-9e74-2c989cf962ee",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5af643e0-e147-48cc-ade5-4d3ab406f8b5",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "dcaeb31e-712d-4baf-b935-5b2921fe8e01",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-14T21:06:53.1067423+00:00",
"db_currency_id": "8ea75625-984f-435a-ac15-b0a37a6c3d9c",
"db_currency_code": "sample string 10"
},
"company_type_id": "705b57cf-1e97-4289-a2ea-15b800043fa9",
"company_type_name": "sample string 32",
"company_type": {
"id": "67a68e63-c163-4189-bc08-9fd13cf0a650",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "11e5126c-3fd8-4a8f-bf40-0cd71a23c590",
"sales_organization_code": "sample string 5"
},
"db_language_id": "41995c0a-195d-4d60-bbc4-6f873388b6bf",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "eb40abff-5583-411a-b1b8-65441ee99cf0",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "cb97e231-1c4a-4e15-8518-0bbc4545ebcf",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e7cc3dd1-b5c1-428a-9c52-6c3f2b1d75ae",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-14T21:06:53.1067423+00:00"
},
"company_sector_id": "5103bda1-82e5-4a75-98de-d895b4a577bb",
"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": "1d102b41-f62f-4264-ad08-900b6119e833",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e504adbc-4f17-40b2-a161-e3f29c86db92",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "1a0d6bcd-9847-4cf2-b13d-536f4bb8d19b",
"account_manager_user_code": "sample string 56",
"company_status_id": "5b13743d-ab6b-4824-a11e-adb4bdca4d1b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-14T21:06:53.1067423+00:00",
"id2": 60
},
"db_language_id": "b85c789f-9285-47bb-b407-57d00fb46173",
"db_language_code": "sample string 7",
"db_title_id": "dca801ee-9d14-494b-86fb-0b0a49d90388",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-14T21:06:53.1067423+00:00",
"create_date": "2026-08-14T21:06:53.1067423+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-08-14T21:06:53.1067423+00:00"
}