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": "b589db29-164c-4bb2-9e3e-cd6a92dd5f53",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "f06cedc1-0086-4706-82b0-67f9e9c5a995",
"company_code": "sample string 5",
"company": {
"id": "c095994c-6644-4116-bf8e-0ba1638512d7",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-15T03:55:17.0270878+00:00",
"sales_territory_id": "7e721f37-f3ca-4015-a725-dad1953fb115",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ccb3392d-ef90-426f-83de-5596e506071e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5984ff6f-c719-4bdd-84b1-9b0932c38fa2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "346f8bf8-7e53-4931-9089-a6b83d7d2acf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8a23bb5e-60e8-43d3-857a-ed8518f774ed",
"db_currency_id": "11061b90-8dc8-4500-85a6-bfe023d00cf0",
"db_language_id": "f848099d-6a49-4530-9487-96a33ece9be2",
"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-15T03:55:17.0270878+00:00"
},
"modified_dateutc": "2026-08-15T03:55:17.0270878+00:00"
},
"marketing_segment_id": "cc96884b-396a-4457-9723-66fdc46c1fb5",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4261914d-5fc8-4830-aa7e-89ce490a8db1",
"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": "bd334646-dc25-4ce7-9497-a5beab8cc109",
"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": "83c82643-71f7-4154-ac38-fc79123fa751",
"db_country_code": "sample string 28",
"feelist_id": "f829f959-47e4-48aa-ab32-00f18b7990fd",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "272d3ae2-4835-44ad-b138-d858388bc20a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c306c9d6-8c84-42c0-8f8c-bc0a30afd437",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-15T03:55:17.0270878+00:00",
"db_currency_id": "b5f0ac93-0cc9-431b-902c-c7992b68c270",
"db_currency_code": "sample string 10"
},
"company_type_id": "1810260f-b23c-47aa-aa8c-7970ad0597b0",
"company_type_name": "sample string 32",
"company_type": {
"id": "937fa87d-3053-470a-a4bd-da439ec045f0",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "306d2c29-3eb9-4e8a-b709-4d408e31579d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "74e0e357-226d-4beb-a9d4-fa5724acc2b4",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "8daba3e2-7423-497b-b7c9-34ec1ff2e6e0",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c3efee59-97f6-41db-a4df-9181fcf1247d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0a0d66cb-20e6-4d63-97c3-a15c1a6d927f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-15T03:55:17.0270878+00:00"
},
"company_sector_id": "210f03e4-4837-487c-8312-ec91adbd0db3",
"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": "4b2706b8-dc4e-4ff0-90fd-227d3218b931",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f9659334-34df-4a1c-aab1-96b7be0f868e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "76e53d9a-8cb2-4940-8587-79b2aa3b7bc0",
"account_manager_user_code": "sample string 56",
"company_status_id": "7c88d8f5-6671-44c3-9878-59767fd4d925",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-15T03:55:17.0270878+00:00",
"id2": 60
},
"db_language_id": "68113370-4c12-47b7-8f76-d3d4314a6917",
"db_language_code": "sample string 7",
"db_title_id": "7db1be15-2797-4c61-aae5-e9301e6ec9f5",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-15T03:55:17.0270878+00:00",
"create_date": "2026-08-15T03:55:17.0270878+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-15T03:55:17.0270878+00:00"
}