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": "64655478-9f8a-4245-98ff-41e97c58ee9d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d75a738e-ae1b-431b-9e0c-ca4f668e4efe",
"company_code": "sample string 5",
"company": {
"id": "7b317a11-60be-40fd-84a7-81f8e4c20e45",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-16T02:31:43.8926445+00:00",
"sales_territory_id": "1c46a02d-9c5d-4d81-b5b4-b6fc2ea79716",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d7ef33de-6119-46d3-9eb1-1642abf322f6",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "68703b42-5b5c-4ad2-a2f5-ebc1ef873305",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b44fd98f-348e-468b-97b7-93dd9bf450da",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ce8bda2c-fc04-4d72-8643-d35aee61fefa",
"db_currency_id": "327c2e83-aff7-4df5-9858-232ebdbae7c3",
"db_language_id": "629ac559-db7f-48db-beaa-edcd888b1c0e",
"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": "2025-11-16T02:31:43.8926445+00:00"
},
"modified_dateutc": "2025-11-16T02:31:43.8926445+00:00"
},
"marketing_segment_id": "cdaef8cb-6f11-4f07-afc5-26c610f2b4e6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "fbe27fd8-7465-4c71-9fec-6e62b77464e9",
"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": "a442e6b6-354c-46b6-b6ff-0a5420b4b13f",
"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": "efee4c1a-50cc-4b2c-9677-c6db78d5aa56",
"db_country_code": "sample string 28",
"feelist_id": "d0cf6582-4f01-481d-8252-c7a99a65ad17",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "fc8a2cf7-6c57-49bb-bad3-10eb5a4b2a0a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "74fae6dd-02f9-48ba-b008-2c545b2edcbe",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-16T02:31:43.8926445+00:00",
"db_currency_id": "7f7f4e9a-bbec-4552-8150-fc313caa2e10",
"db_currency_code": "sample string 10"
},
"company_type_id": "7feec3c9-9321-4e24-b293-d09ea87b279c",
"company_type_name": "sample string 32",
"company_type": {
"id": "04863358-a2da-416c-9b9f-fbf7c673a270",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4e814314-6e12-4875-8b6d-530d487bdec1",
"sales_organization_code": "sample string 5"
},
"db_language_id": "3ba3b0e9-5f48-42ac-a994-5bf2e6bb0725",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c8152dcd-034b-46b7-9b3b-d2a2b10f8260",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "18434a01-bdf4-4c06-8b38-6d8dc04bfd37",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c0e020a3-a7a9-404a-8f2f-4d8edaa79b4b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-16T02:31:43.8926445+00:00"
},
"company_sector_id": "3edd3ea4-485e-42c0-8421-13ba223ba3ff",
"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": "d09a4af6-a125-402b-868a-d05dbf01d1ef",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "8a91896b-23a1-468f-be30-051cb4a43a2f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9c8de967-2c15-4e8a-9c98-ff7417b7d6d9",
"account_manager_user_code": "sample string 56",
"company_status_id": "cbeeb440-fbac-4104-8513-b050e8a7f2fb",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-16T02:31:43.8926445+00:00",
"id2": 60
},
"db_language_id": "1c3f66e9-f7f4-4ce3-955a-d379061005f2",
"db_language_code": "sample string 7",
"db_title_id": "281af31e-49a5-42d3-b44d-58fe2cdf9452",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-16T02:31:43.8926445+00:00",
"create_date": "2025-11-16T02:31:43.8926445+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": "2025-11-16T02:31:43.8926445+00:00"
}