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": "469b2f23-6546-45c9-bcbe-9aa4dea93805",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "df0bff3e-e7e3-44b2-a4b7-87160baf599c",
"company_code": "sample string 5",
"company": {
"id": "b7abdbd3-93ba-4a27-a515-7cfe89be017e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-02T03:50:06.5512774+00:00",
"sales_territory_id": "79d932f8-b8a7-4ed1-a97a-7ef7d266d5d4",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5aa24063-e95b-4621-bcb8-6755ee7ab768",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4d3ed32a-2964-4fc8-ac84-cca2ed720e53",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fe362789-b1df-4abe-b97f-f5da90bbed0a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "69734e36-3667-43fc-a4df-bebd4f57ca57",
"db_currency_id": "0d958d2d-79a7-4fe8-adcf-2e6f625783d1",
"db_language_id": "80e77440-acab-4485-a028-853fed70349c",
"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-06-02T03:50:06.5512774+00:00"
},
"modified_dateutc": "2026-06-02T03:50:06.5512774+00:00"
},
"marketing_segment_id": "190d6267-2089-4aa6-a621-146784e21217",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d8e387b6-6528-479a-9614-6a34264a5ccd",
"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": "5df91b27-d3fd-4466-a9d1-8c6037ca999c",
"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": "29fd1b13-8d1c-4f77-be2a-3b600e2e242d",
"db_country_code": "sample string 28",
"feelist_id": "192a1f95-3a6e-4c0b-936d-1416dec4bf9d",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b8d69546-b410-40bc-bbd8-8826650e4960",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "92aadefa-beaa-4a40-943a-03961765b185",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-02T03:50:06.5512774+00:00",
"db_currency_id": "0ce939a2-57ec-4dca-94cc-09d8784b20ad",
"db_currency_code": "sample string 10"
},
"company_type_id": "977bc2b0-0084-4c78-aa8c-3e2d38f1076c",
"company_type_name": "sample string 32",
"company_type": {
"id": "ff6341fd-65bd-49d5-b53c-e1d1a1692852",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "04a9a0e7-74ec-4c27-912d-ead3dc7cc54b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9f2897ca-b509-4ccb-a0b6-1cb50314691e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e022ae8d-8c03-4e94-b4f6-6b671b8de0fd",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "959cbebd-73c6-46b9-8511-98f1843721cd",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0bfb1577-4a65-4dee-bdb2-34386ab6d166",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-02T03:50:06.5512774+00:00"
},
"company_sector_id": "415ffead-c6fc-4e7d-a4d4-86fb2950f448",
"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": "966da91f-23ca-46fc-af8b-41381274d6dd",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "ea87f699-d386-4ffa-985b-daa4f70761f7",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "15f4f2b7-7a67-4fb2-991e-daad72a113be",
"account_manager_user_code": "sample string 56",
"company_status_id": "85ff3877-d382-492f-a7b8-55928bd9a497",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-02T03:50:06.5512774+00:00",
"id2": 60
},
"db_language_id": "6d6b833d-a76e-414d-97bd-6b9bdca36d4b",
"db_language_code": "sample string 7",
"db_title_id": "0f6b82cf-a372-4b87-90d7-d0d3be9b0bb9",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-02T03:50:06.5512774+00:00",
"create_date": "2026-06-02T03:50:06.5512774+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-06-02T03:50:06.5512774+00:00"
}