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": "0da5ee5b-0957-4840-9809-50986ceed86e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "43b214d9-0543-4dfe-b129-d669258da198",
"company_code": "sample string 5",
"company": {
"id": "aa478882-04a4-4221-984a-9ed609e938a2",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-10T22:48:00.2961593+00:00",
"sales_territory_id": "c755086d-875f-42dd-8979-80402e88d8b0",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "89652f6c-f44e-40ad-ac74-00e9f3dec25a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "674dea8e-2699-4aaf-81f8-2fd4f4855b18",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d1bd6ebb-1630-4d0a-ab14-927d45a3b459",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3f72fe55-7718-4a2a-9581-d35d8c0e7d83",
"db_currency_id": "8fcdd08b-b828-4804-a125-d8eeed0104ae",
"db_language_id": "4e3f6a61-2535-4ff7-b7fc-125cddc1d23f",
"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-01-10T22:48:00.2961593+00:00"
},
"modified_dateutc": "2026-01-10T22:48:00.2961593+00:00"
},
"marketing_segment_id": "3053646e-5ed2-4de1-a3e7-927308ba3581",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4113c4c9-b47d-4909-8555-94859a175cb8",
"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": "2d9d5d9d-e284-422c-bf90-9f54a37d14e9",
"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": "3adad834-5ea2-4f60-a95a-c0c668b07e6e",
"db_country_code": "sample string 28",
"feelist_id": "6ca1e804-8838-4414-b430-7f6a34e42e27",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "0d202b4c-a693-4af1-b56a-089fe960d955",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "16914148-004b-46c6-8bd7-467d50b94d21",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-10T22:48:00.2961593+00:00",
"db_currency_id": "62f87816-e170-409d-9f20-323b66bd00d4",
"db_currency_code": "sample string 10"
},
"company_type_id": "8dfa8b0e-c46b-409d-be1c-0448083eb151",
"company_type_name": "sample string 32",
"company_type": {
"id": "8fb3a902-e2f3-4ba9-8f67-d542ad1b7b96",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "62845921-0cef-4478-943a-f2b9a1424afb",
"sales_organization_code": "sample string 5"
},
"db_language_id": "2381bc88-a2b7-42ee-994e-95de8cef401c",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e4573e29-07d9-4f26-9a94-4988a9de4abc",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4c48e713-11fd-4ab6-acc0-67cdd16a0320",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0c91a5a3-23e4-4275-883b-e9bb937822f8",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-10T22:48:00.2961593+00:00"
},
"company_sector_id": "e4ea86a7-cb94-4535-99f4-6d638fd98551",
"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": "6946aaa7-dcdd-4467-a395-97dd77ef2c9b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "334e8db7-ec9c-40a2-a6da-64e54c9bea5a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "1f4c43ca-cf2a-4af5-befb-2c6306ee1135",
"account_manager_user_code": "sample string 56",
"company_status_id": "836315cd-4ae6-477e-ac62-18d9c10c4a96",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-10T22:48:00.2961593+00:00",
"id2": 60
},
"db_language_id": "091ba9c9-5299-479f-af79-b4276762ebb0",
"db_language_code": "sample string 7",
"db_title_id": "6026900f-11fd-4e83-b85e-5ddbd1ee77c8",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-10T22:48:00.2961593+00:00",
"create_date": "2026-01-10T22:48:00.2961593+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-01-10T22:48:00.2961593+00:00"
}