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": "b66958cd-8adc-4c78-90bc-0e67a09932fa",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "f7c5215f-a2b2-49d4-9071-911e62076d74",
"company_code": "sample string 5",
"company": {
"id": "f5086963-9a4e-4b91-a345-aa20f84c37ec",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-03T07:44:36.257966+00:00",
"sales_territory_id": "0fcaa38d-a523-4ecb-98d8-f28225ec7669",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "96db4564-0189-4cda-a451-6b6d76ec708c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4fe3160c-4ac4-4571-8a71-9ca4ddc470e5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "83295c22-5774-40ec-a366-dbb64f1052ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "de915570-97dd-410f-94d9-63e2a5c89d07",
"db_currency_id": "d94a0dee-62c3-4399-912d-fcb7b50e10f7",
"db_language_id": "9032aa8c-0508-445f-8246-49ccb3272b67",
"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-02-03T07:44:36.257966+00:00"
},
"modified_dateutc": "2026-02-03T07:44:36.257966+00:00"
},
"marketing_segment_id": "336ed49b-da7f-4f12-be63-c2a09d46e123",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7498d5d0-d950-4334-98c9-2a8307efff83",
"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": "2376e585-df1a-4271-aff1-bd69dbbf89e1",
"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": "4eebe90b-8d39-4c44-b269-d035e082f460",
"db_country_code": "sample string 28",
"feelist_id": "1c99949d-0531-4019-b486-fa2c333f7f81",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3aeb3516-561c-4a56-9eb1-2ae2a0ea15e6",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d171c884-dd12-4eec-9b1a-746882e9840d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-03T07:44:36.257966+00:00",
"db_currency_id": "2bb83641-4724-4735-8c27-b14e9729d8ce",
"db_currency_code": "sample string 10"
},
"company_type_id": "b948b568-0e57-4ddf-a46a-e2dcc62d6864",
"company_type_name": "sample string 32",
"company_type": {
"id": "ab517536-0542-47c6-99ce-2867e1b97b4a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ea7382e8-a1e3-4396-8422-6e63625f5b8e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "43004f06-8aaa-4f4c-95ce-87cf2e2efd97",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "287a0aaa-b99d-449f-9430-f025fc6e546e",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b6df5e6e-690f-4130-bc34-bdb533654c8d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a515ed6a-67f2-4b2c-88ae-0800279b9069",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-03T07:44:36.257966+00:00"
},
"company_sector_id": "b1c73ccc-35e2-4c53-b83e-a75402aa16dc",
"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": "b261f4d6-2507-4963-9dcf-1c186e780857",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "653c2030-e392-45b5-8a26-f245514d123f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f9ebae44-690a-4af5-b9ee-35f54019d6d5",
"account_manager_user_code": "sample string 56",
"company_status_id": "619cd279-9b6d-4d2a-afea-733f56edd45d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-03T07:44:36.257966+00:00",
"id2": 60
},
"db_language_id": "bf92171e-49d5-43ad-b466-df37e588c27a",
"db_language_code": "sample string 7",
"db_title_id": "75843411-e3ab-4f24-9f0b-91b7c32f185d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-03T07:44:36.257966+00:00",
"create_date": "2026-02-03T07:44:36.257966+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-02-03T07:44:36.257966+00:00"
}