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": "04db0534-70ed-4009-84bd-abd65a49dd53",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "aa1bdf35-85a9-4363-bff8-629b4e57aa66",
"company_code": "sample string 5",
"company": {
"id": "7a3118ae-7a9f-40fc-a28e-790eceee785a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-11T16:45:08.9294651+00:00",
"sales_territory_id": "6fbaefe8-72c8-4dbf-a2eb-025969ac708f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "030bd87f-e8c1-4d5e-9d96-792c76eb6916",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b14b0dab-f391-4248-978c-78be67089e3f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "13b0f048-5aec-4b03-b098-9c0e11a05e99",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a331c12-8950-415c-9f75-fba0c5ab72e9",
"db_currency_id": "d9049b33-4223-4041-8645-5d3488cf69fd",
"db_language_id": "c0191df6-1b5e-491f-b711-e9a200696cdc",
"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-06-11T16:45:08.9294651+00:00"
},
"modified_dateutc": "2026-06-11T16:45:08.9294651+00:00"
},
"marketing_segment_id": "d61ebd87-4801-4c67-ac7f-167a69629794",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7a423219-46a9-49dc-959f-c1148ad9e85b",
"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": "36daa62f-2928-431c-8b0c-d408baf8bcf9",
"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": "c1ddf07c-fdd9-40e7-bc3c-ad11c0c91fd4",
"db_country_code": "sample string 28",
"feelist_id": "19d5f634-87a4-497b-b4b5-83dbc2112c6d",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d17700d7-328a-444d-9923-655c146ffccc",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "0ecba9e4-2928-44b7-8cd8-2c27069daa56",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-11T16:45:08.9294651+00:00",
"db_currency_id": "010cc6dc-ed32-44e5-875d-0f9b6b9ed056",
"db_currency_code": "sample string 10"
},
"company_type_id": "ca8aea4a-6ad4-48da-9095-23df6fc9303d",
"company_type_name": "sample string 32",
"company_type": {
"id": "90975aa6-0a18-4899-8019-ef27acc8212c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "74a63c15-389b-4a9d-ae4f-568f32c30330",
"sales_organization_code": "sample string 5"
},
"db_language_id": "2de55796-8e41-46fe-8dcf-730875f6b5c6",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "36dc0490-2d34-4727-8672-6a191d00d890",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "6a603229-d3b8-48d1-a45e-6cc68c1b93b9",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "de092ca7-cea5-401b-9e9f-7016900dd8fe",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-11T16:45:08.9294651+00:00"
},
"company_sector_id": "a2e1b8e2-5832-414b-a78e-bd1736220703",
"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": "96197059-37b6-4efe-ad94-ce258caaf61f",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1c981af0-372d-47b1-8c43-485b37e24f7e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "71f60d6b-a469-4a82-992b-70b89b043300",
"account_manager_user_code": "sample string 56",
"company_status_id": "3f9f4dee-8f94-4031-ac46-ae055288b787",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-11T16:45:08.9294651+00:00",
"id2": 60
},
"db_language_id": "e8eea5c3-7d16-4262-9202-89c924620aa8",
"db_language_code": "sample string 7",
"db_title_id": "63aa285d-0fac-41ca-99ef-616ea9920c8c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-11T16:45:08.9294651+00:00",
"create_date": "2026-06-11T16:45:08.9294651+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-06-11T16:45:08.9294651+00:00"
}