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": "01632377-bdb3-4f2d-a106-0e03c1b68112",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7fc81084-d85f-4289-95ab-3371c0c37888",
"company_code": "sample string 5",
"company": {
"id": "8087809d-0a3a-4c81-9a7e-98b90c8407cc",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-05T20:55:15.7642072+00:00",
"sales_territory_id": "4f753113-2fbc-4bbb-9c9c-c79310b60048",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "8fbe34ad-ca27-468f-807b-cfa01e1f47fb",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8d60b5cc-d227-48eb-999d-239047e6ab80",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "48ba35a5-0c90-4da8-b0fe-edc6eaf97161",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4f1dfc2e-fe3f-4b59-b79a-bb3f6b77cd3c",
"db_currency_id": "859d6d05-2497-4224-ad4f-4083d7ad5f93",
"db_language_id": "2a6cdb2f-306c-4c34-9cde-e9e107943c2a",
"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-12-05T20:55:15.7642072+00:00"
},
"modified_dateutc": "2025-12-05T20:55:15.7642072+00:00"
},
"marketing_segment_id": "fe1f8982-2768-4d79-9aac-bb2cb3bec393",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "67955631-5566-46b4-9045-b26ca6497754",
"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": "b68de5c7-8a49-4c03-8434-a898eb9d2465",
"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": "94bcecbf-561e-44e3-83a1-112c4ebc3dc2",
"db_country_code": "sample string 28",
"feelist_id": "3a6fe03e-aa9d-413f-bf7d-ca474542504b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "bf856991-89fa-4625-92f6-2fd60f4ee5ff",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d2e418e8-d851-44e7-bf18-4be54e64b84b",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-05T20:55:15.7642072+00:00",
"db_currency_id": "edcc5827-a064-4a0f-a1b7-b1f101d432ac",
"db_currency_code": "sample string 10"
},
"company_type_id": "df65f58d-af93-464b-b096-1fe92a999f18",
"company_type_name": "sample string 32",
"company_type": {
"id": "691e769e-9a91-458e-9eb1-f059319c34b3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8a5615d0-32ae-48fa-8e04-ac5e7fe9fda3",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c660a1ce-1b8e-4665-b7ba-e04ac1c1eb4b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c9c344cd-13aa-4506-a434-03ceedb94592",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "6c8c4b6a-5c59-4e90-8678-82d68fab10f0",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2f89700f-30f7-41b5-9ba5-70d234959a37",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-05T20:55:15.7642072+00:00"
},
"company_sector_id": "51db49f3-8c45-4d3e-ad8a-7782d4fcdefe",
"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": "e3253bf8-943a-47e8-983b-af3c54375004",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "7cba3e06-bd24-4320-a99d-9411d77c6ea4",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "02d171b5-76c5-436d-8e6e-c4b5fae6f288",
"account_manager_user_code": "sample string 56",
"company_status_id": "9c721055-981e-4b5f-a9b8-51da5558b001",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-05T20:55:15.7642072+00:00",
"id2": 60
},
"db_language_id": "3d68e46e-b968-4dcc-999a-701afb1cca4e",
"db_language_code": "sample string 7",
"db_title_id": "decc5c03-470f-4465-af88-ab1c5bda675c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-05T20:55:15.7642072+00:00",
"create_date": "2025-12-05T20:55:15.7642072+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-12-05T20:55:15.7642072+00:00"
}