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": "f6ca885b-4962-42c8-8efb-942d0f05c962",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "23044373-ec4e-49e8-9a90-f55e6d77de18",
"company_code": "sample string 5",
"company": {
"id": "eefda8ce-693a-4812-bec6-76959c825ca8",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-09T13:40:50.6449455+00:00",
"sales_territory_id": "3221256a-4c78-4572-a0ae-ac6015fc7bb6",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "990bd795-ccb7-4022-9eba-99e2b517f33d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "73014327-126d-4b24-9414-2a71a9a65344",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3affe391-46cf-4515-b0f0-c7afb3450dc6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d29c6463-dcea-45ca-83aa-fabc87c20a6b",
"db_currency_id": "7b015c8b-4600-4dd4-b346-01ec0f0cf8b7",
"db_language_id": "91e03b86-1570-41de-afd5-436ee2608c55",
"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-11-09T13:40:50.6620574+00:00"
},
"modified_dateutc": "2026-11-09T13:40:50.6620574+00:00"
},
"marketing_segment_id": "24405375-4ab5-4821-a44a-d7f8e4abb56c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "95842d08-100a-4285-9164-cef46cd1acfa",
"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": "6178db9b-3c96-45ad-83f4-f8d3e0a04620",
"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": "b8a26c61-f384-4a8b-a5d0-08d206250198",
"db_country_code": "sample string 28",
"feelist_id": "5cbecc1d-78b0-45c3-909b-9c49af3976c9",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5258bff7-88eb-4069-8c80-17b6ba8ec95f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "afd0935b-3477-407e-82c0-a816ed73aaff",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-09T13:40:50.6620574+00:00",
"db_currency_id": "ddd8548c-9e24-4f45-8a7b-61ecd8a2da57",
"db_currency_code": "sample string 10"
},
"company_type_id": "a7048db0-4b80-4609-ad11-edda298b197d",
"company_type_name": "sample string 32",
"company_type": {
"id": "1431d7b1-0ae2-455e-8e80-0b1ab11cf8c1",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "167b26b5-426a-4f66-aeb5-e0d7ce067f4d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "963b269d-c2ae-456f-92ec-e80f63e32c65",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d719b881-33c8-439b-8e01-dc2a9a426f53",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "ad146c3b-37e9-4201-ba0b-2b696266d530",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ec252cf4-c8db-40fe-bb3c-f558dd8a3078",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-09T13:40:50.6620574+00:00"
},
"company_sector_id": "d1314f2f-22bf-45bf-afc3-513998642c91",
"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": "61083e3d-90d8-4da4-806b-a21f1130d67b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "9842db61-381f-43c3-89bc-6f808d5dab87",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c344cddb-9e60-47a8-952b-54b990eb4e35",
"account_manager_user_code": "sample string 56",
"company_status_id": "62c53f3f-471d-4584-a2c1-635f272541c8",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-09T13:40:50.6620574+00:00",
"id2": 60
},
"db_language_id": "8414e52e-9605-4cd6-9639-887b7eeaf72c",
"db_language_code": "sample string 7",
"db_title_id": "6b22c3ef-4694-4d05-a959-1ba762b00da3",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-09T13:40:50.6620574+00:00",
"create_date": "2026-11-09T13:40:50.6620574+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-11-09T13:40:50.6620574+00:00"
}