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": "18a08da5-ab3c-4d7b-8f1f-5011aa16f465",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e47859be-6f33-4b23-9ffd-ec1f0d67d7ff",
"company_code": "sample string 5",
"company": {
"id": "f39b19dd-86ab-4277-bd40-794d3e3ebf4a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-14T04:29:01.001631+00:00",
"sales_territory_id": "a064eec3-87a1-4e00-a176-5f17d0dec061",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d32b4c64-4f6b-4e1a-b538-a1133cb32b20",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "68162a5c-ce7e-41ae-aff3-142b1b7a6f0b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7813d988-4b12-4c2c-8982-92820607e1c3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6567f4d3-339b-4a7e-8ef9-b59fd33d7133",
"db_currency_id": "130588b0-5731-4114-8df2-5f5447933fe8",
"db_language_id": "9cd2ba3d-03c4-4f5d-8e2c-a4e5ef601135",
"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-14T04:29:01.001631+00:00"
},
"modified_dateutc": "2026-08-14T04:29:01.001631+00:00"
},
"marketing_segment_id": "e6d65386-d3f5-4653-b46d-c81fa62b9e08",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "16c87aec-2ebb-42b7-995f-282eb0d02323",
"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": "b3b56030-c740-4c08-82be-7008ca5e2e48",
"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": "9be4b7db-3f8b-4db0-967a-0d345d1ae940",
"db_country_code": "sample string 28",
"feelist_id": "3792dce6-9573-4163-a020-391e99b12211",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3dc4e869-d20e-4621-8d01-1576026602cc",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f15f2e40-a6c2-4244-aac7-85c1b675c016",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-14T04:29:01.001631+00:00",
"db_currency_id": "0c572ab3-cc1a-49ac-9f72-761085714a7e",
"db_currency_code": "sample string 10"
},
"company_type_id": "d77afb20-f96a-4c95-9a71-5f81b0b0ed42",
"company_type_name": "sample string 32",
"company_type": {
"id": "f5969201-4189-4c27-9eb0-a4b1cc5e8ca9",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "96603f42-e070-4a8e-af2b-352fbdc3c49b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "97ab486d-f4cd-44b2-bad2-2871de90d761",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "8015f855-fcb9-4126-80b6-b19bd18d68be",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "57b80fba-62e7-4185-933e-3bd8a034367b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "56f6abe2-5e1b-4bf5-853d-0e4be7021a51",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-14T04:29:01.001631+00:00"
},
"company_sector_id": "e3b332a6-5cbb-4c9c-97aa-208631f0d5d8",
"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": "8ace9e0d-2139-4522-9e79-a90312957d13",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "bbb27f25-c749-4da8-a22c-19da177687ee",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "5f511f26-7e07-48f3-945c-6ee42085f1af",
"account_manager_user_code": "sample string 56",
"company_status_id": "1e69aee1-05e8-4a9d-b0e1-eb778ce5f697",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-14T04:29:01.001631+00:00",
"id2": 60
},
"db_language_id": "ac85c636-2d81-4d42-8f24-3deb5b3ae8fa",
"db_language_code": "sample string 7",
"db_title_id": "35c64ed0-c32d-4b91-9947-da3a845c9e5c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-14T04:29:01.001631+00:00",
"create_date": "2026-08-14T04:29:01.001631+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-14T04:29:01.001631+00:00"
}