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": "deff906b-9314-45ac-9248-cef35e9876a8",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "1697b9b7-8020-4554-abff-cb802abb9ee5",
"company_code": "sample string 5",
"company": {
"id": "3d81b8dc-28ab-4825-a640-c84b3d02d711",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-19T08:16:24.5609725+00:00",
"sales_territory_id": "965b9360-b17a-41ae-9060-16b47f665795",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "19fcc951-824c-4550-9fd9-e36d65430031",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0a56ab6e-6c64-49e7-8cc5-2eeee00c3745",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3a86fe97-db10-4a9a-9614-86541b0ce1e6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e154d97e-b1d2-4b38-a1db-f117cdcb79e9",
"db_currency_id": "1ae94b1c-937f-4623-b9b6-8903d9df561a",
"db_language_id": "148bb588-5b49-4010-afa4-e647b14007dd",
"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-10-19T08:16:24.5609725+00:00"
},
"modified_dateutc": "2025-10-19T08:16:24.5609725+00:00"
},
"marketing_segment_id": "6a95959f-8943-4a25-9dcb-eab8d3b8ee5d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d141a8fd-d38e-4fa2-8234-51e384d4924e",
"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": "c82eed89-07d0-441d-a2d5-7ffdacc8602f",
"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": "51ca0891-c5f2-4d26-a308-1b63cc760ad0",
"db_country_code": "sample string 28",
"feelist_id": "506ef82c-3c1a-42cc-a926-c949ec9b6d5a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "adb30708-9e0b-4915-bcf7-bb02ebe3fdfe",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "dc602066-2824-46d8-a0a0-8aa810cbd738",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-19T08:16:24.5609725+00:00",
"db_currency_id": "3b9e8513-49a6-4e31-9a16-1d744fee8e76",
"db_currency_code": "sample string 10"
},
"company_type_id": "0640e864-0b5c-4381-9305-6d5e6a07f0f9",
"company_type_name": "sample string 32",
"company_type": {
"id": "2b1a0a3d-8ecc-4458-bef5-8f8374091c0d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9722734d-5831-4b39-999c-4faf6ef66316",
"sales_organization_code": "sample string 5"
},
"db_language_id": "87d66b85-e8d9-4823-86a7-03d73d0a565e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "705071fc-569e-462a-9dae-4dd88ee6555a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "dac338f7-2af3-4b6e-8999-b87c48a4eb32",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "96d0be03-4210-4bee-93df-c1e229f44915",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-19T08:16:24.5765947+00:00"
},
"company_sector_id": "d3ba04c9-c7c3-4c94-938b-1ee2a2104a7a",
"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": "7aa60b90-467c-4a68-94a5-185efc5c5c8d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "3382dea2-e6a8-4510-8ccc-b28cf2908dd8",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "831f544b-b062-402d-80e3-313511dba465",
"account_manager_user_code": "sample string 56",
"company_status_id": "473ec761-80cd-410c-a67f-36da23258849",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-19T08:16:24.5765947+00:00",
"id2": 60
},
"db_language_id": "51f29c08-08fe-4dce-a594-f0fdea10e7ca",
"db_language_code": "sample string 7",
"db_title_id": "4d0d9a67-1b6b-4842-8b66-fe08524b976f",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-19T08:16:24.5765947+00:00",
"create_date": "2025-10-19T08:16:24.5765947+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-10-19T08:16:24.5765947+00:00"
}