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": "a50388ae-538b-4b10-9735-89fb46d89f39",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4196006c-480c-44c4-a434-79794a140c26",
"company_code": "sample string 5",
"company": {
"id": "301e8b62-2bc4-4ecd-b72f-ac9609788142",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-15T12:46:57.9443548+00:00",
"sales_territory_id": "b4dfb941-0f4d-4564-8f62-2347984ec407",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0c02204c-623a-4bd1-b8e1-3af613e5c687",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "11aef52c-52cd-4f03-9d11-3f3078095ee8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "92341652-d439-40d5-a90e-9933ab0b373f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f630e57f-3777-4ffd-818e-94743e8aa1a6",
"db_currency_id": "edfdb0ad-2b6e-44fd-b4e1-9041ebb0e082",
"db_language_id": "a79570ce-321d-4f3e-839b-c23a69452e16",
"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-15T12:46:57.9443548+00:00"
},
"modified_dateutc": "2026-11-15T12:46:57.9443548+00:00"
},
"marketing_segment_id": "6fddb8d6-e644-4b5c-8534-993486a5ce7e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "289bcc69-7c23-4eb0-af85-4d3bbee70f49",
"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": "30a30667-1ea4-4c18-ab31-e6819475fef4",
"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": "0c6150ba-5049-4c81-8b5e-f786e2aa6a8e",
"db_country_code": "sample string 28",
"feelist_id": "1aab9385-5837-42b5-954a-850f3a39d661",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3b3eaedf-2958-4039-843c-f1622f73f851",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8a19a8a8-3a73-4f2f-8d42-2fbc984ba370",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-15T12:46:57.9443548+00:00",
"db_currency_id": "37269bd3-bed7-4447-838d-7cce36216a30",
"db_currency_code": "sample string 10"
},
"company_type_id": "6ceb4548-cfab-4431-840c-4ee4076964a0",
"company_type_name": "sample string 32",
"company_type": {
"id": "93d2e142-aeef-4a06-8fe2-03b313abd853",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9d2e44d5-deea-47ae-907e-8c39cecc2b3b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a3030eb1-eb16-47f5-98f7-fc14b26138f9",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c193e413-3c65-4bda-ac81-41dbeab8dd2c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "51a09fe0-ee2a-4b0f-9a2b-c74129cfd9a8",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "149d04e3-cbbd-450b-a2cf-0898ba2b419a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-15T12:46:57.9443548+00:00"
},
"company_sector_id": "4c2dc27a-c96a-418f-b666-eeec946030c8",
"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": "6a3e57e7-0ab4-4227-a2d1-1dcb5238a400",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "aa5339cb-c3bb-4c64-a8ec-d830fb44c8f3",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "cfa61ddb-d6f3-4931-aaab-bf66d9e47af9",
"account_manager_user_code": "sample string 56",
"company_status_id": "41b75425-748d-44fe-82a4-c6a14bae7a40",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-15T12:46:57.9443548+00:00",
"id2": 60
},
"db_language_id": "76cf08a5-3a9d-46c5-808d-375d2111370a",
"db_language_code": "sample string 7",
"db_title_id": "9ca89c7f-192d-4d34-9927-bbc4550e3d41",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-15T12:46:57.9443548+00:00",
"create_date": "2026-11-15T12:46:57.9443548+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-15T12:46:57.9443548+00:00"
}