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": "14f3f372-bcec-49df-b0a1-e65c2bfd63b8",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "42a084e1-e6ce-4ed6-bb06-3ea2ed26980e",
"company_code": "sample string 5",
"company": {
"id": "c0b80722-7f83-43d8-8cf5-fafdcf471269",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-10T05:28:15.2418066+00:00",
"sales_territory_id": "b5a275cc-2e1f-42fe-b688-1f23350eec85",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "6a177f53-5f99-4fc3-b88f-ccb738f3d422",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1576d574-c079-47e8-afd4-7dea52a86b03",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ee942301-3124-484e-9d4c-a1b7e07e9760",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0606a753-881c-48ef-ab3e-ce1bcebbea60",
"db_currency_id": "28a7c717-a394-4730-a8b9-5fe04f70c2c7",
"db_language_id": "d77756c0-1a45-4635-9bdc-e8a0f7ef1ee7",
"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-10T05:28:15.2574399+00:00"
},
"modified_dateutc": "2026-02-10T05:28:15.2574399+00:00"
},
"marketing_segment_id": "f1f3f882-6bf7-4b6f-9bf3-d7ab647e6d24",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "46eb42d4-b632-43cd-bffc-317dc80ca78d",
"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": "e82ba253-649b-4cda-a18f-9a26895d4597",
"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": "d3de773b-9f2f-4a55-9f28-b3109d1e8fc0",
"db_country_code": "sample string 28",
"feelist_id": "16a8021e-9d4a-4207-8d7d-6b921a1081ae",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b40db4d1-8498-44dd-a5fb-318ddbceade8",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "577a5922-5f83-471c-a402-79388b2b0773",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-10T05:28:15.2574399+00:00",
"db_currency_id": "19ed5690-5468-4d6d-a7f1-ff4025cc264d",
"db_currency_code": "sample string 10"
},
"company_type_id": "9786aba6-bbc6-4978-acb8-8df1e674d92e",
"company_type_name": "sample string 32",
"company_type": {
"id": "ca27bba2-cfbc-4509-b68f-9c71d3107245",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a4bb3ab1-2ea0-440b-baf3-8f4b1b1d60fb",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c57ec4be-fe2b-451e-bc3d-e9093fc6dc16",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "82935607-9d67-4aa8-aeac-f25b62c9e5cb",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "396410a1-9fc7-4769-9aeb-530e9fb57b9e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "953cf97d-4653-4047-8012-512231967c47",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-10T05:28:15.2574399+00:00"
},
"company_sector_id": "18bfeacf-d8a0-49ad-af18-0018e0e9bc2d",
"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": "bff24736-0894-424e-8b94-3f5538680a16",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "92cda11d-f081-4f9a-9256-cfbe5b49abac",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "10cbd6e7-516a-439d-ad0c-caaa42e3fc5e",
"account_manager_user_code": "sample string 56",
"company_status_id": "a5e5aafc-3b8e-4f5e-b47a-a510e22813e8",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-10T05:28:15.2574399+00:00",
"id2": 60
},
"db_language_id": "59564468-e9af-4a63-a892-77a25ee4f141",
"db_language_code": "sample string 7",
"db_title_id": "432f9948-1526-41b7-b2e6-95fcf6a079cc",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-10T05:28:15.2574399+00:00",
"create_date": "2026-02-10T05:28:15.2574399+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-10T05:28:15.2574399+00:00"
}