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": "4846f13f-507a-410e-b5f1-7efdf141cf58",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "efe77e79-0892-4c63-82ab-5ee3bceed0f9",
"company_code": "sample string 5",
"company": {
"id": "a87d7260-ad97-464a-889e-b323810a13b0",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-15T13:20:53.6743105+00:00",
"sales_territory_id": "6dc69bf4-5074-4234-93fd-2ab3e52b6ca0",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "4f661149-dfb8-41aa-b13d-38edfec0aa59",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fd2fc557-29a7-4b38-8117-c90294c6e60e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "910f26c9-85cd-4a5c-9dbf-e37f0c83f613",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "466eb1b9-d671-4138-b15b-da719dcbe167",
"db_currency_id": "497fe950-945c-484a-900a-0ae51dd07102",
"db_language_id": "26eaff91-6d4b-408f-816f-d52784898ca8",
"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-15T13:20:53.6743105+00:00"
},
"modified_dateutc": "2026-09-15T13:20:53.6743105+00:00"
},
"marketing_segment_id": "4efa0666-316c-47cf-8e76-740dfbb9df1b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "fa8f1bdc-9037-40e7-a83e-da7cd25da107",
"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": "a72dd64c-5421-4d18-bdcf-628f390ed71a",
"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": "584d978b-796c-4d41-a822-971d3283bd59",
"db_country_code": "sample string 28",
"feelist_id": "064f0fe9-99dd-4edc-8e59-b13b94ac27f0",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f2a7956d-4f8d-447c-b8e5-bf4db21d344e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ff270823-9252-45b5-9897-a84300a5ba36",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-15T13:20:53.6743105+00:00",
"db_currency_id": "43be2170-4a60-4fae-9d37-af22908573f4",
"db_currency_code": "sample string 10"
},
"company_type_id": "7f549c1f-b53d-45a5-9a5a-fd9a31d88fa3",
"company_type_name": "sample string 32",
"company_type": {
"id": "c4ef0ff8-20ee-4a5a-88f7-1d054fc3ad77",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8632b1a0-0696-47bc-bf56-8641103bb881",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ef93ab52-b82f-478a-afe7-cc77d6834d43",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "246e03a5-02d1-4262-83a7-892d29ae1763",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b5f3056e-cc11-4714-a97d-3b81d2c3c46c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ca6102a2-39ea-41b1-872f-ae8c1f34b757",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-15T13:20:53.6743105+00:00"
},
"company_sector_id": "0fc5de3b-3363-4d57-ba80-f90c23401419",
"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": "88aba521-d0da-43f5-8c75-e3923f7371d5",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "59beae9c-9f59-4d3a-89c5-ab90e07fdfd1",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d0ebe75b-3aa5-499f-a6c6-e3d65e4d7cba",
"account_manager_user_code": "sample string 56",
"company_status_id": "8f6e2964-a58b-400f-a9a2-f48b10f85e65",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-15T13:20:53.6743105+00:00",
"id2": 60
},
"db_language_id": "bdcb4d8a-a73f-4ae8-b009-b08c2039e8f4",
"db_language_code": "sample string 7",
"db_title_id": "ca3a18f9-072f-4cda-94a5-99e63a9bb6fa",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-15T13:20:53.6743105+00:00",
"create_date": "2026-09-15T13:20:53.6743105+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-15T13:20:53.6743105+00:00"
}