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
{
"id": "e9327b10-2632-4267-ad63-fe5a2d9215ae",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8a3efb4b-08e2-4fb8-93ac-8d2cfa875287",
"company_code": "sample string 5",
"company": {
"id": "a3bf36ca-1acb-4e26-9c16-dc11c7e17c60",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-19T20:03:37.5277831+00:00",
"sales_territory_id": "7a0faff1-cfbb-46d1-83d2-a3de223af48b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "bc7cdcbc-ff3a-4b5f-8ecb-237682847760",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "272a5cbd-325b-475f-88c9-1db2a1138c0a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ccae7126-280d-49cd-8ad6-9d553dae66c7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8d271450-9350-44d4-9cdd-a612d74ba9c5",
"db_currency_id": "4498c4b5-f2f7-48fb-b1b4-95dbd781a94f",
"db_language_id": "e3ce8084-95a8-4501-a17d-a610e1761863",
"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-11-19T20:03:37.5277831+00:00"
},
"modified_dateutc": "2026-11-19T20:03:37.5277831+00:00"
},
"marketing_segment_id": "3009c932-94ce-4012-9f80-dba56f91fb6a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d3b83121-693a-4edb-aa11-7da3679a5732",
"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": "91a18281-e0ba-4cdc-982f-629c754da90a",
"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": "2405400a-3b0b-453e-8250-ca2d85479e5f",
"db_country_code": "sample string 28",
"feelist_id": "3237ee6c-09fa-455e-879d-d91f777d55c5",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e02557da-c4a1-4f4e-aa37-21ac036be1e5",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "2a8031a7-3711-49ce-83ed-4f6519667bf3",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-19T20:03:37.5277831+00:00",
"db_currency_id": "e46f8f10-019d-4909-a079-d9906f77260f",
"db_currency_code": "sample string 10"
},
"company_type_id": "a3363b84-95f7-4bb9-bc16-e2e0340072b8",
"company_type_name": "sample string 32",
"company_type": {
"id": "caacdba1-ba4b-4793-b862-4a82493367b7",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "213dbcad-01e4-45c5-b748-0838de1060bd",
"sales_organization_code": "sample string 5"
},
"db_language_id": "88f1de5d-971d-406f-bd08-bab5f7d8b78a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f1a3c4dd-a1ab-4bfc-a3a6-d6d90582ebba",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "eff82e95-8426-4b85-ac59-0b8530588f76",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "af237689-9de3-4bc1-9c12-ed5b4b891ac8",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-19T20:03:37.5277831+00:00"
},
"company_sector_id": "bc4dc439-0fec-4144-bd4c-d2c7ee54e65a",
"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": "e13143e5-8bad-4327-82a2-a3dab4261379",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "24f86036-0202-4d23-b1f8-53d7b3bccfb9",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "be2954f7-21cb-4cfc-a2a6-5a333fcb4dbb",
"account_manager_user_code": "sample string 56",
"company_status_id": "0eaa4e5c-2fc5-4007-9d1a-cf4165b016c7",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-19T20:03:37.5277831+00:00",
"id2": 60
},
"db_language_id": "97dee850-6c11-42e1-b130-91a0250dcfa6",
"db_language_code": "sample string 7",
"db_title_id": "80465e7c-ab58-4537-a713-9a5a869260b7",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-19T20:03:37.5277831+00:00",
"create_date": "2026-11-19T20:03:37.5277831+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-11-19T20:03:37.5277831+00:00"
}