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": "f5c944c0-2af2-45f6-8dfd-92b65addc9d4",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e47a819d-402d-4e3a-9227-aaba48d9bcdf",
"company_code": "sample string 5",
"company": {
"id": "0d9aa31b-db66-4fe7-bad4-d6bffe124998",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-01T01:00:42.418307+00:00",
"sales_territory_id": "efb6e9bc-7c78-4d07-b6ff-cc954d856ba8",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d434e365-c0a8-496a-a5e0-f31e21b4d14d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3bc3840f-703e-429c-b365-7307d2915f79",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "cba9d3f9-84d3-44a5-aded-803a5d6ae65b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a29542e-69bf-47b2-adf0-2d9dc79e35f2",
"db_currency_id": "880e2a22-9d91-4be6-bbac-a0e9c0a70cfb",
"db_language_id": "ff37ee54-d9ed-4bca-ac52-c335728307cd",
"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-07-01T01:00:42.418307+00:00"
},
"modified_dateutc": "2026-07-01T01:00:42.418307+00:00"
},
"marketing_segment_id": "ee395bf3-65e0-4bda-a781-ea1c82c2c69e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a4ef33b4-0811-4d8b-9bfa-fa13488567e9",
"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": "ef9a9327-c501-4ca3-b609-c64ab9d2f64c",
"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": "22f5b154-6e6d-4dd7-90c0-dfc4e0c55481",
"db_country_code": "sample string 28",
"feelist_id": "ac4acdcb-9cce-46c7-adf3-d9da0bd9aab3",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "04c77288-808c-4fce-9f3d-236fd78c1b9b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c8d85fe6-c677-40e4-bbd0-ae676a94117e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-01T01:00:42.418307+00:00",
"db_currency_id": "7ce1e168-6068-4d33-8801-e8a31fca1492",
"db_currency_code": "sample string 10"
},
"company_type_id": "1da3b392-602d-4b0a-aa37-119a2fc6d971",
"company_type_name": "sample string 32",
"company_type": {
"id": "05e0fddc-f68c-4c90-8d05-75f7a419e848",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9c57a492-3cc3-43de-b4fe-87025aa62a75",
"sales_organization_code": "sample string 5"
},
"db_language_id": "df08e191-1468-424e-9013-1821acc00793",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "35514870-a219-49ac-87dd-957db7d5a9a4",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "697ee4ad-333a-447e-884c-251167b705f0",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0353d1df-798b-4112-b724-e431a7605466",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-01T01:00:42.418307+00:00"
},
"company_sector_id": "56ed527e-ad7a-4feb-a251-59939fa9a734",
"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": "098409ee-b817-466b-bf66-3b514b2ba129",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "4990c728-99ec-47c4-9a4e-c15d47b31a3f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "40d0b807-f8c2-4395-b3cd-8c3ffc272348",
"account_manager_user_code": "sample string 56",
"company_status_id": "916abbd5-2feb-47e5-b417-9e84c3581420",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-01T01:00:42.418307+00:00",
"id2": 60
},
"db_language_id": "93445855-8ea9-41af-aa5c-9bde34234d70",
"db_language_code": "sample string 7",
"db_title_id": "b29512c6-936f-4c7b-8a22-4acf5e00a192",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-01T01:00:42.418307+00:00",
"create_date": "2026-07-01T01:00:42.418307+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-07-01T01:00:42.418307+00:00"
}