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": "e74e0207-14f6-481a-b954-1dc762b338a9",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "75c837e3-e8be-42d0-a62a-60804fb1f09b",
"company_code": "sample string 5",
"company": {
"id": "17821ac3-a9b1-4093-9b7b-d3a2b88e9dd8",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-19T08:40:45.4314371+00:00",
"sales_territory_id": "6e72835f-2d53-4de2-a9ea-f5cac798ad5e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5c68479b-6089-4c43-a73b-b050fa4b35d3",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a08fcf9a-f5cd-4664-a903-56f67dfbf3ea",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7903fabd-7653-4e60-a5df-e7e670753316",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cb042e56-c9c9-4d15-bf3e-59d7ccd0ba55",
"db_currency_id": "649b9a38-e270-41ba-a581-5199cf12a852",
"db_language_id": "f231e9e7-ec79-4f7a-a43e-d62a0c4acf2a",
"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": "2025-11-19T08:40:45.4314371+00:00"
},
"modified_dateutc": "2025-11-19T08:40:45.4314371+00:00"
},
"marketing_segment_id": "f5d0a7af-4398-4a80-8b31-1e76604c0e17",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "79edf049-1718-4201-8755-5cdf2aa3b295",
"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": "a6449509-e0f0-4173-bb9b-b99b20a1971a",
"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": "ff473d57-8f85-4801-af5b-445e52de9b3d",
"db_country_code": "sample string 28",
"feelist_id": "b7685176-5841-489a-ab4d-6dceb5929df3",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b8308837-6511-491f-a9d0-fe302811f61e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "3827caa2-9842-481a-8860-eda62f15efa7",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-19T08:40:45.4314371+00:00",
"db_currency_id": "5205b708-36cf-4fd0-8433-656768d9b29c",
"db_currency_code": "sample string 10"
},
"company_type_id": "f2d47183-f843-46e1-84a0-925503932885",
"company_type_name": "sample string 32",
"company_type": {
"id": "b24e02c0-cdc9-4fa9-8251-b43e6594441a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bdb231de-ea62-4292-b9e5-46483c87b80e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0638cd22-3641-4c83-828b-d9dfed8acd9f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d75d2983-27cb-4420-80b2-a5b3bc7794f0",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c2b83794-d800-496e-915c-9825bbff9b4f",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "30379a07-c200-4db6-91b9-e82486cff08e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-19T08:40:45.4470635+00:00"
},
"company_sector_id": "4039f1e3-a180-4d32-8e3e-6d011ccb99c0",
"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": "e319657b-7c08-44c8-9cc0-4e419c53ee39",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "3f56a798-a3d1-4ee0-a2b8-21995d8c26d6",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "7c543ddd-1dc0-41c7-ba92-2b15c5e9d06e",
"account_manager_user_code": "sample string 56",
"company_status_id": "edc73c19-914e-4534-8aa4-49daeffac62c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-19T08:40:45.4470635+00:00",
"id2": 60
},
"db_language_id": "8b91461d-ef43-4230-9fa1-ca44536dd21c",
"db_language_code": "sample string 7",
"db_title_id": "f92c5db2-d2e6-4a46-a515-83b2f7b29a7b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-19T08:40:45.4470635+00:00",
"create_date": "2025-11-19T08:40:45.4470635+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": "2025-11-19T08:40:45.4470635+00:00"
}