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": "07147957-3960-4c62-94a1-472def4829c3",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "5680c5dd-09cf-451f-a7b4-05525dbd5d3e",
"company_code": "sample string 5",
"company": {
"id": "6198e741-e12b-4301-91f9-4af0ca20f6ad",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-11T01:25:18.7362163+00:00",
"sales_territory_id": "817c0499-c658-40ca-9b85-29152d27e2d0",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "eee9da94-8dbc-4e78-b3d1-b965e3f835a3",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9a6ee116-883d-45b8-a7a9-ef83ca1228e9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "349cbf0b-5d61-49ed-9af6-9f03a626245b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "221b10d7-67a1-40ec-8e6a-d24ba02c170b",
"db_currency_id": "514e375d-bc71-4be2-801f-5f3fbd4c01d6",
"db_language_id": "0192b5bf-45c1-4ef0-9526-7101395def3c",
"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-08-11T01:25:18.7362163+00:00"
},
"modified_dateutc": "2026-08-11T01:25:18.7362163+00:00"
},
"marketing_segment_id": "85d6e538-38c8-4fdc-aaf6-85c9e463df0e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "92e35f5c-c2e0-464f-ad6c-b6ad498e8055",
"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": "9f152cd8-96a8-4372-b7df-46ff4fc7cfc2",
"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": "55863111-1a4a-4d20-9325-8d4c3b947576",
"db_country_code": "sample string 28",
"feelist_id": "f2682400-6d63-4792-b446-5be273daebc9",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "89aece0b-4736-4912-a10a-3f62bd7568ad",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c86bd9ac-ec36-4a13-94e9-dce13b8071e9",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-11T01:25:18.7362163+00:00",
"db_currency_id": "61057f36-18de-4149-94cf-eff35609a973",
"db_currency_code": "sample string 10"
},
"company_type_id": "bd432676-9d79-468e-9790-129b286d72b9",
"company_type_name": "sample string 32",
"company_type": {
"id": "76110c28-e8e1-4257-9fc4-e794b739d46d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "884d61a7-8bf1-4a36-9d40-89df46d1d5be",
"sales_organization_code": "sample string 5"
},
"db_language_id": "fa9a2a5b-b8f1-4244-9120-d7d82f78bbae",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "eec5b57b-3e2c-4f31-b252-1693151516b9",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "7d63edb0-6e3b-4000-aa63-81c7548447c3",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7107460f-acf5-4420-ad34-04644de23301",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-11T01:25:18.7362163+00:00"
},
"company_sector_id": "0f25d57f-005f-4423-95c9-36db30de8f63",
"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": "c5e7effb-e674-483b-bee1-7f3c71f2b54f",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "db585edc-e344-45f6-8c2c-0afd2251e50a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a38901b0-f7a0-4726-bfae-fd1e3d702199",
"account_manager_user_code": "sample string 56",
"company_status_id": "8503f27b-01c5-4804-9728-3a7749538548",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-11T01:25:18.7362163+00:00",
"id2": 60
},
"db_language_id": "17eabe17-c7aa-4803-bca4-ff112d14c73c",
"db_language_code": "sample string 7",
"db_title_id": "e87b3ffd-5d94-40ac-9d4f-d648ff2a4629",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-11T01:25:18.7362163+00:00",
"create_date": "2026-08-11T01:25:18.7362163+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-08-11T01:25:18.7362163+00:00"
}