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": "2be849fa-f71c-4e7e-bca1-481a1d237e4e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "dd54cb11-84b3-4905-92f7-165d64c4dfc5",
"company_code": "sample string 5",
"company": {
"id": "46ed92ad-87bb-402f-8d62-6fe18aaedb0b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-09T12:19:40.2628416+00:00",
"sales_territory_id": "9cf3af5f-c1d3-4ad0-8c88-dc8a955ff834",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d7d583b5-1b1f-4cd0-b866-f5cb7611203e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c9e6b60d-bc0b-421e-98bf-c9b2b7f747f0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a4fa1581-06d9-480a-beb0-bd37fc6707d4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e884f6bf-546d-40f0-a74a-3f8903847637",
"db_currency_id": "0a0f16cf-eb28-496d-b327-663e3bc32af2",
"db_language_id": "3a0ddeb4-c00f-4e53-9f19-1e7f41aa1f57",
"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-09T12:19:40.2628416+00:00"
},
"modified_dateutc": "2026-07-09T12:19:40.2628416+00:00"
},
"marketing_segment_id": "c22e344b-4ed4-471a-bd27-bcc919d2ce11",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "eda5994e-4a18-473e-a62e-42197a20ebf9",
"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": "a7d0eee8-a906-4b0c-a8f5-ece2656bf539",
"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": "bc99cbc0-6338-4427-9049-6e4f6048295d",
"db_country_code": "sample string 28",
"feelist_id": "adac7f62-882a-4364-847f-242cc876a32a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "dfc03388-21d0-4be0-ac6f-f7b0616a9fa4",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "344adca2-b7f7-4e9e-8b62-9ff99d52a087",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-09T12:19:40.2628416+00:00",
"db_currency_id": "ba7ddc60-2073-4360-892b-cfe5a548f809",
"db_currency_code": "sample string 10"
},
"company_type_id": "c42a181c-f857-4ee4-aac8-101d1dab26a2",
"company_type_name": "sample string 32",
"company_type": {
"id": "1fb4f83e-8fdc-4d86-bce5-15f21ae837aa",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d66ef7fb-2c28-4ac5-9642-57dfca14637b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9edeab23-0144-43b5-aedd-f2bd5d8c9e31",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "9adfc082-babd-470c-a40b-fdd308734b44",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1ba8f372-f7aa-4ff5-922d-e93d14236fbe",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c1fb62fd-7ecc-4150-b29d-a69b775374e8",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-09T12:19:40.2628416+00:00"
},
"company_sector_id": "88e4c022-e680-44ab-86e3-da73bff49be2",
"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": "9396035b-0474-43eb-9bf2-e4f1727eccbc",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "22fb381c-f703-46c1-a96f-15f3372c0546",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "65c56fa5-a604-499a-bb86-ef63c43fb0f3",
"account_manager_user_code": "sample string 56",
"company_status_id": "26e813f4-ae74-4e67-ae02-51743894b572",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-09T12:19:40.2628416+00:00",
"id2": 60
},
"db_language_id": "d0c484a6-fbfa-44c4-97ae-04851be54e89",
"db_language_code": "sample string 7",
"db_title_id": "f77966ad-6e3e-4127-b45a-09633be51770",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-09T12:19:40.2628416+00:00",
"create_date": "2026-07-09T12:19:40.2628416+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-09T12:19:40.2628416+00:00"
}