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": "2be9fcf2-7dd6-40f9-80be-a44fb21c3f6d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "56eae1d8-847b-4ed2-9008-51d9e9713964",
"company_code": "sample string 5",
"company": {
"id": "272215e1-8f8a-45c1-a4f6-c6307f775b15",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-14T13:56:34.3435467+00:00",
"sales_territory_id": "33704018-0587-44de-8012-02249dd21007",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c12d30c0-0443-44ae-8073-27a5e4763d37",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "843c3319-e9a5-492b-8970-bbb648dea3b8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "96941637-cf65-4d67-8f9d-e41a3b482722",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d775c372-ee15-4b1b-8028-5b0f3f5204e9",
"db_currency_id": "4dfa4cc4-5f97-4fce-9141-3f4fc0b26a53",
"db_language_id": "348335df-1616-4e0e-a090-dff7bd77067f",
"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-10-14T13:56:34.3435467+00:00"
},
"modified_dateutc": "2026-10-14T13:56:34.3435467+00:00"
},
"marketing_segment_id": "239b0ec9-6bb5-43ea-b103-18e8ca7f158a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d0988f20-6194-4dec-b070-44d53cdf38c4",
"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": "5c4c0259-aa1c-4b9f-a812-7a7c850a3756",
"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": "96502249-a835-4797-a152-2a9cdf2afe30",
"db_country_code": "sample string 28",
"feelist_id": "dd75bc77-491e-441b-9989-06fd6c256a43",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f97afc77-9312-4005-b4f0-cfb95a39db09",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "4e203689-b382-44ec-b5f2-1174ceb2c469",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-14T13:56:34.3435467+00:00",
"db_currency_id": "48ee1578-8958-4af4-be5a-b2cf12d6ccd8",
"db_currency_code": "sample string 10"
},
"company_type_id": "c64827a6-1b67-4b24-b97a-f7fb2efb0f4d",
"company_type_name": "sample string 32",
"company_type": {
"id": "db767dad-9769-495a-b6f9-72fb0304c3f7",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e61f3b85-e4cd-40a4-9833-a419a1002cd4",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1c96180f-0b31-44f6-a919-146ad0deb2b5",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "18ac0444-5da5-4504-b34a-e5172ce2d3c4",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "5fee1f16-0187-4b44-849f-ddc64a8188fb",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a0dc4b8b-219a-4538-ba4d-6095e18db284",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-14T13:56:34.3435467+00:00"
},
"company_sector_id": "3b40e951-bc88-4c9a-9781-9a3121599b02",
"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": "3e4db779-0719-4dcd-b7e3-59e83d8b2b13",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "bce6bcab-b336-4f34-9cb0-d415a219fa17",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "df43abfb-a8cc-4161-9831-ca5d38f0d92e",
"account_manager_user_code": "sample string 56",
"company_status_id": "4d67e529-2c7d-4f24-91f0-d011d0f3719a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-14T13:56:34.3634049+00:00",
"id2": 60
},
"db_language_id": "a959f0f3-5289-4807-8bd1-ca067a1c0f09",
"db_language_code": "sample string 7",
"db_title_id": "7e88a1e5-406b-4ade-bc44-227aec746dd8",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-14T13:56:34.3634049+00:00",
"create_date": "2026-10-14T13:56:34.3634049+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-10-14T13:56:34.3634049+00:00"
}