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": "b0710c5b-1ebe-4880-9417-061509ccfdb3",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "aa56ee8e-de79-4f83-8a18-d575f4c54d57",
"company_code": "sample string 5",
"company": {
"id": "196620d0-d7c4-4e0b-bc60-6930feec2212",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-04T13:28:15.7930394+00:00",
"sales_territory_id": "4fc7bdc5-2a32-4ef6-a5c3-fc0ee4693112",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a359c4b3-976e-4887-9920-6118e9115bd9",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bf0c3b23-49f0-44fd-ade8-ecc67665ced4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "df768871-ce8f-48c5-b3f9-4ba36611333d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a72a5396-8de0-4594-a964-d0f303f7b333",
"db_currency_id": "b54ec997-26f4-4a00-8464-3d4ea7c11008",
"db_language_id": "9ff9ad0e-ec7e-458d-8981-d5a5036527c3",
"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-11-04T13:28:15.8086392+00:00"
},
"modified_dateutc": "2025-11-04T13:28:15.8086392+00:00"
},
"marketing_segment_id": "1c20717f-c0c3-40b8-bf4c-a1908af578ee",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "950faca6-66cb-4006-bb2d-7e89ba10ea08",
"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": "2f46d7f8-c32a-4f56-864a-4bcd527b6fc3",
"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": "ee8a8829-98eb-45e1-b666-5ef5d31b1eb6",
"db_country_code": "sample string 28",
"feelist_id": "6c6ceaa8-a8a1-48c7-bad4-48a1fceb7027",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "9d8dae1d-4b8c-4e76-ae58-43172407e72f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "513a6317-583a-43c5-becb-8944680e4996",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-04T13:28:15.8086392+00:00",
"db_currency_id": "6126bde5-5599-44db-b13b-4f2b2ccb6439",
"db_currency_code": "sample string 10"
},
"company_type_id": "f9079c9e-33f7-447c-85d3-2f51954bff80",
"company_type_name": "sample string 32",
"company_type": {
"id": "e0ec1c51-b7df-406c-8361-d9147ddcfd46",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2a060985-04ad-4547-b851-802d2609f8ba",
"sales_organization_code": "sample string 5"
},
"db_language_id": "29bb54c0-bb8f-4e2a-aff8-852e0397ae1a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c7229cfa-2b12-465c-8c3f-33b01fe35511",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e69b59ce-ef56-4431-bb8b-06c73d5c40a8",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c4408f48-dcfb-4a34-9c36-137434fc8d23",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-04T13:28:15.8086392+00:00"
},
"company_sector_id": "4fc24177-1e32-4947-a62a-07929ed89d07",
"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": "bc514243-3120-4c0d-92cb-4af846c50f71",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b91bfc43-4977-47a5-809d-4e378e35a9e9",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f5fae103-9df3-46ea-bbdc-001dccaa1268",
"account_manager_user_code": "sample string 56",
"company_status_id": "b14ed665-e027-402f-88b8-ee94f2c8537b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-04T13:28:15.8086392+00:00",
"id2": 60
},
"db_language_id": "021ecc5c-e91e-43b3-a166-9266d4a6239e",
"db_language_code": "sample string 7",
"db_title_id": "631bed83-5a2a-4836-8ad3-d50b97f256f3",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-04T13:28:15.8086392+00:00",
"create_date": "2025-11-04T13:28:15.8086392+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-11-04T13:28:15.8086392+00:00"
}