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": "ad960e04-7cef-4090-b74d-30e596db0cc9",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d03e40c8-78bf-4d36-bd26-44dca5535ac2",
"company_code": "sample string 5",
"company": {
"id": "9dfe816b-8b80-416c-8e2a-15976d3dc421",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-31T22:14:26.3450178+00:00",
"sales_territory_id": "ff042926-341e-4c5f-8f45-b5b8b13b2232",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "6618bcf2-9f83-41d9-965c-7649c1d3b20c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b3592f4d-0c15-45eb-89fb-b8bd05a53206",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b013cedb-8c7b-4a34-98fa-e3d494ea3185",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8434c853-e31c-4fc4-bb9e-46fca38d4b97",
"db_currency_id": "b678e47d-5243-48be-a635-c617bdf7c199",
"db_language_id": "6ecb7a00-498d-4d9c-8400-f9d233ec9fd2",
"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-05-31T22:14:26.3450178+00:00"
},
"modified_dateutc": "2026-05-31T22:14:26.3450178+00:00"
},
"marketing_segment_id": "76cadf7d-8740-4c86-9016-26bb2d4773f5",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4535ed93-a6eb-4b9b-b7a9-b7d609cb4890",
"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": "4c5dfbac-9547-470c-b302-d05113ee75e7",
"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": "c14506e1-c5ae-406f-88ea-12030d83e6a5",
"db_country_code": "sample string 28",
"feelist_id": "e677aa88-da37-49ea-9430-1dfa948adb1a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "0316c8b7-b0f0-4160-9ccd-7cf8ad03e735",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e9e3160b-b37e-4cc0-9dcb-fb88a0764bc6",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-31T22:14:26.3450178+00:00",
"db_currency_id": "982be2d9-9455-4345-a14e-1aae6e51b7e5",
"db_currency_code": "sample string 10"
},
"company_type_id": "5e22a075-b590-4bab-a82e-6c805918f611",
"company_type_name": "sample string 32",
"company_type": {
"id": "bb928975-fc07-45f0-9f47-53502d8f7d2e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d41ff341-3a20-4bce-bfa1-8ab9c98b21cf",
"sales_organization_code": "sample string 5"
},
"db_language_id": "eea0f2b3-5f4e-4201-a9be-cdd08bcac47a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "669dd929-7a4c-4ef9-ae86-9fd01abb358b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "213314d4-98cb-49a2-af01-d92f64cc38c2",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "993fc54c-af60-405d-b5bf-fcf5c75229f3",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-31T22:14:26.3450178+00:00"
},
"company_sector_id": "b8b51a07-b701-4fdf-9c7c-d845caafb3c5",
"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": "a437c88e-bae3-44e6-848d-7a5f16452695",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "9da29745-db80-4a1f-b023-0cc59c238085",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "5ff70ada-21a9-4106-b848-912bb3c9be2d",
"account_manager_user_code": "sample string 56",
"company_status_id": "8f69a2cc-5b32-4146-9e79-326e3bfbb817",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-31T22:14:26.3450178+00:00",
"id2": 60
},
"db_language_id": "069cf502-7ef4-4644-bacb-cbaac9c204b5",
"db_language_code": "sample string 7",
"db_title_id": "1745f371-7317-4b8e-bc73-5f7b488b98a8",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-31T22:14:26.3450178+00:00",
"create_date": "2026-05-31T22:14:26.3450178+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-05-31T22:14:26.3450178+00:00"
}