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": "8e2a7a26-42cd-43ad-b7ed-1093c7d5302a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0af64722-7139-4b9e-a8ed-2fdd232f125a",
"company_code": "sample string 5",
"company": {
"id": "257427e2-1bc7-4ea5-a660-e32d768688cc",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-25T03:44:18.647192+00:00",
"sales_territory_id": "9a050967-5068-4c45-bc8f-325b2425eaad",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c0bd628c-2c3e-4040-a463-d1011d37ed97",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b3c70812-9081-41b4-bb21-91a172b91924",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2ee8b0b2-2830-4072-9735-92774e4d3eef",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "61ad7468-37fa-46e5-8fc6-78f5e757d28a",
"db_currency_id": "ff67357d-d166-4984-b3c3-3c615f56f47d",
"db_language_id": "e8f25772-da7e-4049-accb-9b6e76ef0003",
"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-09-25T03:44:18.647192+00:00"
},
"modified_dateutc": "2026-09-25T03:44:18.647192+00:00"
},
"marketing_segment_id": "abc3100d-2044-4528-b5e4-e96e142bb6c4",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "56239a89-e2cb-44a2-b17b-d5ebbd4c5cb0",
"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": "853f15b7-f792-4587-b88e-d25b9cc5fa46",
"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": "bf052a6c-9424-44fe-8f71-9104f7347521",
"db_country_code": "sample string 28",
"feelist_id": "62c3fb89-183b-4c48-a63e-c99d1d05bfff",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "98d46deb-1e52-4655-b178-3abdc47fd3e4",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ebdab4f4-afe4-4a70-9869-5cefae89b832",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-25T03:44:18.6628167+00:00",
"db_currency_id": "16192330-943b-4e0c-bdc0-522faf83f70c",
"db_currency_code": "sample string 10"
},
"company_type_id": "b87da059-a0bf-4937-af35-ef39a71ef337",
"company_type_name": "sample string 32",
"company_type": {
"id": "1636445e-2ebd-47c9-88a6-19eff3421087",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cc498ef7-4e47-43d0-9031-7fd0570a2a3a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d470f8f3-49a2-4210-87f5-a51637e7b6ee",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d18a188c-d563-4cd1-99ca-aee10be2467f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c980c658-a4db-48d3-aed3-50d80f55efe6",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "66e96e86-199f-4a77-890e-a2eedf3c86c7",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-25T03:44:18.6628167+00:00"
},
"company_sector_id": "287b18d9-cedd-4684-89c1-6451a9bb01d9",
"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": "85a30e1e-8709-4ac2-bfa5-aae21cb45910",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "69d2d2ba-f42b-4ea4-a4f1-7cd8e3aaaee3",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "84c4cc9c-1442-4915-a720-a7639834a177",
"account_manager_user_code": "sample string 56",
"company_status_id": "2e67e348-49f4-4b37-9e9c-71bd69ac0987",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-25T03:44:18.6628167+00:00",
"id2": 60
},
"db_language_id": "e0dc0518-61d0-41f6-a1a2-cd92656ce54c",
"db_language_code": "sample string 7",
"db_title_id": "b107efa4-33ea-40c3-a9f1-6bf2a62f919d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-25T03:44:18.6628167+00:00",
"create_date": "2026-09-25T03:44:18.6628167+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-09-25T03:44:18.6628167+00:00"
}