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": "9f525861-c9e1-4c60-801b-6c98da16d7bc",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "fba8e953-1c68-4b7f-9556-5949335cec65",
"company_code": "sample string 5",
"company": {
"id": "88a0d013-d072-4cc8-b3a7-2af2d2eb6e6b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-25T15:08:19.7933939+00:00",
"sales_territory_id": "856c2e53-c565-425e-ad15-4fb803f3767c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f8c7c7f8-947c-4e5a-a5ae-5f757bf81cbb",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e5ddcacf-91dd-4955-82ff-fabda526a1e5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d5dfa026-edb6-40b4-9b43-2ba86c7d7f5f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b3f2e30a-bfaa-4df9-ac23-320fa182d81f",
"db_currency_id": "041e97ff-4b85-4052-b36d-a78bce49a0c6",
"db_language_id": "7f208627-065d-4f14-aa75-199f5f4a8d87",
"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-01-25T15:08:19.7933939+00:00"
},
"modified_dateutc": "2026-01-25T15:08:19.7933939+00:00"
},
"marketing_segment_id": "870cb54a-4649-4a3a-99ac-68d7c9bf7a38",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c99d6045-0d31-4443-9612-541b52e7d989",
"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": "5dfdaba4-2e70-4df4-b1ba-5ff205a29b04",
"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": "a7dd1160-581b-4d82-bcbe-9cb36b80ee59",
"db_country_code": "sample string 28",
"feelist_id": "31b5457b-cbc2-4cc3-bd91-8d97a57d660c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ccb1ca74-699e-4da7-8303-cb02398cded5",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "506235c2-1138-4535-b669-a7c344d4ef44",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-25T15:08:19.7933939+00:00",
"db_currency_id": "d07fd9dc-e468-4f90-be6a-bed618740106",
"db_currency_code": "sample string 10"
},
"company_type_id": "ff39a932-1c7f-4719-bf4b-f730415c376e",
"company_type_name": "sample string 32",
"company_type": {
"id": "03991194-c86e-491a-98e4-b1c270ce1bed",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0a4299b1-901d-4b1d-8354-73b0acb36656",
"sales_organization_code": "sample string 5"
},
"db_language_id": "da0aa5e5-7512-4bb8-ae57-3f60ef1c8522",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "451b81fc-acb8-4a64-b2ca-3d6b975fde1c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "30ed98e1-25c6-4747-bfc1-e53be7b60fc8",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2401e30b-c5f6-4677-a689-6004a98fb61a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-25T15:08:19.7933939+00:00"
},
"company_sector_id": "a0bf38fb-3223-4b57-ae73-abd969f2a412",
"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": "a2fe0f7f-499b-4224-8b4a-6d742971692c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "aa68e423-a698-4b88-89ab-870d3190d8c5",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "4bbdba4a-6a89-46e4-9745-c6dd0a638280",
"account_manager_user_code": "sample string 56",
"company_status_id": "9a3db0b2-cdf3-4509-8d4a-5b56400a92d1",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-25T15:08:19.7933939+00:00",
"id2": 60
},
"db_language_id": "819b099f-ac44-4375-b2a3-7aac6006659d",
"db_language_code": "sample string 7",
"db_title_id": "fc99682b-3833-466a-a253-94b679adb681",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-25T15:08:19.7933939+00:00",
"create_date": "2026-01-25T15:08:19.7933939+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-01-25T15:08:19.7933939+00:00"
}