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": "ef553142-6eb2-4800-923d-73be349137e2",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "54664f7b-bdad-459e-996b-b3d008bdb74c",
"company_code": "sample string 5",
"company": {
"id": "c3e21aaf-f7c7-4af6-a3c7-4a9d69691475",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-04T08:48:33.3413367+00:00",
"sales_territory_id": "055e8ba4-b7b2-426a-bdef-9a3f861b49f6",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "104075e3-dfbb-46f0-b26f-2f25f663cdb2",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a7ca2829-17ed-44e2-a993-f013eb444abb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "79a12621-7a42-410c-ad4e-7c82df9c5170",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4b6e1487-c91f-496c-a7c5-a1361280e9ec",
"db_currency_id": "3c321643-85c1-4318-8ed1-bd5dba850028",
"db_language_id": "323c0257-3472-4cde-8d74-8b85672e3fd0",
"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-04T08:48:33.3413367+00:00"
},
"modified_dateutc": "2026-09-04T08:48:33.3413367+00:00"
},
"marketing_segment_id": "f6bdf48c-6d51-4d54-8452-df27ffee4c40",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "12089721-80ee-49b4-a845-afddab982d10",
"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": "27268560-402d-457b-9c94-a3482aa78c78",
"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": "e920c7a5-42d0-4a0e-92b4-2400d791ecc1",
"db_country_code": "sample string 28",
"feelist_id": "e4852089-3e43-4e6c-b0f7-778d8561120e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3bad2210-ade4-4f5f-ae9a-bf7258ce0e72",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "99c560b4-31b6-401e-995e-f1b67cbdb855",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-04T08:48:33.3413367+00:00",
"db_currency_id": "dc5815cb-fa35-4ed4-a604-a9968d226308",
"db_currency_code": "sample string 10"
},
"company_type_id": "4d49e65f-3081-4e44-8221-4a21b37fc091",
"company_type_name": "sample string 32",
"company_type": {
"id": "084a5a01-f4d2-4be7-a180-719bb2021c01",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1bc794f8-ad79-42bc-9e61-28d0c33fb15a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "368d3c5a-c57f-4364-92e8-e9a5a1c8b046",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e579176d-4410-4331-9829-7b6547dd2b02",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "56a1d215-c447-4837-a129-efb3454e5120",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "bfd31719-f92a-4de2-8845-086c08d821bf",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-04T08:48:33.3413367+00:00"
},
"company_sector_id": "960d325d-ec43-4773-b1ba-527e7fdd2ac9",
"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": "b83667d2-8c8e-4211-bea0-886ec6075108",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "abf468d2-8d74-4b6c-adb7-d8f8af3d657c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9630d304-dde6-4257-b2d4-9175c6610a28",
"account_manager_user_code": "sample string 56",
"company_status_id": "b2227601-bf0e-4f22-937a-309fe74c9609",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-04T08:48:33.3413367+00:00",
"id2": 60
},
"db_language_id": "d759f907-da6b-4802-8eb3-fdf3b13f31e9",
"db_language_code": "sample string 7",
"db_title_id": "7d04dc32-9dfe-4d21-b38a-c22843da58df",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-04T08:48:33.3413367+00:00",
"create_date": "2026-09-04T08:48:33.3413367+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-04T08:48:33.3413367+00:00"
}