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": "796debaa-1d35-457a-8f4f-10714345c73f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "fbc8ecfb-a914-4a7b-abc6-f765a6d02ff5",
"company_code": "sample string 5",
"company": {
"id": "46c16ac9-46ce-4bf7-a94f-13ac7bcc589f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-21T07:31:52.0779533+00:00",
"sales_territory_id": "11a21f16-963c-44e5-9a52-33d6502b31dc",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ab34d1c3-6882-4507-a11b-c226df74f473",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8bdd1888-3a2a-46ec-90c1-7c23be53e1ca",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "db02b88a-3bee-4535-a2e4-74f77a4c65e8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "35e0d1e4-f173-4b4f-9e2b-f853944f1191",
"db_currency_id": "8cb1405d-6e85-4f07-8bf1-0d7cad2ad73e",
"db_language_id": "c2ec6dc1-71ce-41dd-8305-ffc34d06f600",
"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-09-21T07:31:52.0779533+00:00"
},
"modified_dateutc": "2026-09-21T07:31:52.0779533+00:00"
},
"marketing_segment_id": "c2253b5c-2651-472f-bf0a-24f50d1c6583",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "3bbd39a2-13c7-4703-b0e9-385d85ecfc45",
"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": "d71ce3ff-18a5-49e8-9424-24468cf5f934",
"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": "103f8b53-7df8-4142-959c-b276ff769632",
"db_country_code": "sample string 28",
"feelist_id": "14c3cb50-527b-42d3-a51c-faa882779513",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "bf001ebc-1130-4899-9a03-0b13cb4d06ab",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "108e4134-e4ff-401a-8530-97ac6e320c58",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-21T07:31:52.0779533+00:00",
"db_currency_id": "6233c7f1-8aed-457c-b183-729e73f1593f",
"db_currency_code": "sample string 10"
},
"company_type_id": "9d8d4c81-5b74-4de4-88bb-a432b5b220a0",
"company_type_name": "sample string 32",
"company_type": {
"id": "979e628a-6282-4fa1-beb2-367296dab39f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c1a847d8-5222-477d-8e4e-7a949d46ac1f",
"sales_organization_code": "sample string 5"
},
"db_language_id": "cf77e31b-904c-4b3c-9cd3-f56d6b36886c",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7a1d8199-a781-4d6a-9242-80ae40e2de5d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "ca1f599e-38eb-45b9-896b-12ef7faa07a9",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d7361ecc-17a6-47e1-8a7b-13f021a6a59f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-21T07:31:52.0779533+00:00"
},
"company_sector_id": "0c09bebb-027c-481c-b7d2-fef6c4e9d1f0",
"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": "f15e1685-ddf2-41d8-8fc6-6e39c52fc081",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1050ce05-cd15-431b-97ba-8b13006a2c6c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e358ec0c-ca1b-4c49-9c54-46faa9c601c4",
"account_manager_user_code": "sample string 56",
"company_status_id": "45e65677-a1ba-4d4b-aa16-b0334d57f8c9",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-21T07:31:52.0779533+00:00",
"id2": 60
},
"db_language_id": "da0a6ae6-8d4f-4586-b283-cc4a062617ac",
"db_language_code": "sample string 7",
"db_title_id": "deba9b7b-8e36-45e1-ab83-dca1c99c1644",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-21T07:31:52.0779533+00:00",
"create_date": "2026-09-21T07:31:52.0779533+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-09-21T07:31:52.0935749+00:00"
}