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
{
"id": "2d325589-5379-44d0-a025-8c3ed878976e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "19712ece-d3ca-4f51-b1d0-6d16e796fa13",
"company_code": "sample string 5",
"company": {
"id": "0dddc743-d4de-4538-a044-ca33e971f476",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-21T16:11:36.1288273+00:00",
"sales_territory_id": "9257efeb-8f59-403e-a6e6-2bcfe4b76e14",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "15fea4cc-1aa0-4cba-a8ab-dd98be09467a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c8af86eb-7f7e-428a-87c2-9094bac68e22",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c8125681-1dd7-470f-b1b2-2d713fd062bb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "97b25dfc-0bef-4d1d-bedb-2f9995e1e0bb",
"db_currency_id": "170fbf59-9a85-4482-aad0-1159fbcb6e13",
"db_language_id": "0d95ba1b-edaf-4532-820e-e09471c6c4bb",
"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-11-21T16:11:36.1288273+00:00"
},
"modified_dateutc": "2026-11-21T16:11:36.1288273+00:00"
},
"marketing_segment_id": "6aaae4fb-3dee-432a-95a8-f9436477fbe5",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "435ccfe6-c88f-4f6b-8454-034ffdc320ef",
"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": "a4bca50d-4712-4f96-a763-5103bc59226c",
"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": "9a30374a-3258-429e-90d9-bae14c38e4c5",
"db_country_code": "sample string 28",
"feelist_id": "a1105232-3179-44df-a007-281abd314368",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "9054c63e-74ab-45e8-a89d-7e51e66c4125",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "25df424a-4707-4daf-abb2-4b91cec66f56",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-21T16:11:36.1288273+00:00",
"db_currency_id": "c201fe67-b797-41f1-bc0e-b68a8fbd27cd",
"db_currency_code": "sample string 10"
},
"company_type_id": "e5aee3fa-c3e4-4a20-8cf8-bc83b0b02949",
"company_type_name": "sample string 32",
"company_type": {
"id": "de2a3ca5-ee16-45af-b057-5d29db397bfa",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "51d87267-b871-4120-8bd3-1acdbbddb9a2",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5046b962-7b51-49bb-9c9f-aa8548459e79",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "86c03e49-96b7-4e9d-babb-711793f23344",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "02dfcd02-f8d5-4bfb-9c04-d70dbc5d4cbf",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ddf61dfd-0d70-45ca-9f4a-41f9deeaa9e0",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-21T16:11:36.1288273+00:00"
},
"company_sector_id": "4c461e38-0ac5-4d09-a38e-60ab9347c932",
"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": "eac0c492-6fea-4a02-b3c3-8dda3a5072cc",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f30cc448-95d1-47d6-9d4a-9f9ffac48639",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "7194d492-892c-4084-9294-aad2784083ac",
"account_manager_user_code": "sample string 56",
"company_status_id": "5d61f5da-4b0f-48d8-a202-7c4522c4f076",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-21T16:11:36.1288273+00:00",
"id2": 60
},
"db_language_id": "6febcc2b-4c55-4079-94c4-9d8e4056eafd",
"db_language_code": "sample string 7",
"db_title_id": "3df2f5ca-61bd-473d-96df-24c8ad7e7a76",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-21T16:11:36.1288273+00:00",
"create_date": "2026-11-21T16:11:36.1288273+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-11-21T16:11:36.1288273+00:00"
}