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": "4e4bc044-0226-49aa-bedd-076b3ff8d56b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "69558b75-7d95-4bf5-b16b-8406a5ab3813",
"company_code": "sample string 5",
"company": {
"id": "cfca9ac2-568e-46d3-a7e7-e04a9cf43262",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-02T02:35:32.2003534+00:00",
"sales_territory_id": "76010e9d-b24e-45b9-a56b-2eca86e38413",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "bc270a8a-1ce9-4f29-b321-ea3b82e7e7a7",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2711a1bc-2a7a-4bb2-b72c-b3c56f8d3577",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ba02cebd-9adf-41b0-b767-0e374a1ed3b9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b5e9e809-edf4-4af9-a6c2-b886692ef83a",
"db_currency_id": "a457a6eb-8707-4831-ab73-367e9b8ffbd2",
"db_language_id": "cffc5a4c-19a3-43b2-b8d8-2ef35260a030",
"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-02T02:35:32.2003534+00:00"
},
"modified_dateutc": "2026-02-02T02:35:32.2003534+00:00"
},
"marketing_segment_id": "5fe41100-63aa-424c-9f66-80fa45c7e565",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "57b238f7-f94a-4958-8940-bb3a4f092d5c",
"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": "23df6aaa-7ade-4066-bbdf-da5bb3c5888e",
"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": "a9fc9f9b-735e-41cc-85a4-fd7d30cd83d3",
"db_country_code": "sample string 28",
"feelist_id": "11d100e5-3b7c-412d-9503-ff27ef5b4a11",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "188bbf80-7e32-455a-b81d-c8d6be0c4fb2",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "6ad36e7a-0e9d-4acd-96c4-4988f1a01748",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-02T02:35:32.2003534+00:00",
"db_currency_id": "13aa0d5b-0f59-42c7-87c4-16aa77da6cf7",
"db_currency_code": "sample string 10"
},
"company_type_id": "979760d3-6e78-4658-9e64-cb4070edefa3",
"company_type_name": "sample string 32",
"company_type": {
"id": "bffe84b3-1905-4624-9df2-ab66388ded9e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "59f6b405-f309-4bb0-968a-7768d3af1f88",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9b8eef95-06cf-495d-82bf-490b867881ba",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "da84970b-9838-4f69-9da1-57aaec6905f3",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "2a516658-cbe4-4203-abed-98f620fdee59",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "935c5b7a-b1cf-4761-a762-1c3d68ca82ff",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-02T02:35:32.2003534+00:00"
},
"company_sector_id": "a82a5f56-c394-44e5-b290-22ee404ec21e",
"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": "694c13dc-6e22-4355-ba55-cb76249d6167",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d0b740bb-c7f6-4457-9514-9136f890edd3",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8c8f032a-1dea-42d9-a6c0-0e6e58d7b865",
"account_manager_user_code": "sample string 56",
"company_status_id": "a62d1afb-23d3-4c07-bfcf-e9e95a2bae02",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-02T02:35:32.2003534+00:00",
"id2": 60
},
"db_language_id": "7e91ce85-7f52-4d76-adf4-cb0c8e25a3da",
"db_language_code": "sample string 7",
"db_title_id": "a73d258b-92ac-477e-97d0-3da041a372f7",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-02T02:35:32.2003534+00:00",
"create_date": "2026-02-02T02:35:32.2003534+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-02T02:35:32.2003534+00:00"
}