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": "0aba12e1-2f2c-4846-9ca4-1e052264d1df",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e188895c-1dac-4ff3-92e3-75ee6e91e148",
"company_code": "sample string 5",
"company": {
"id": "88a76e8f-591c-4539-b356-cf5b3df6398f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-07T06:42:18.3130457+00:00",
"sales_territory_id": "f4df4bca-0442-4e95-b204-1cc232e501d2",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "23eff682-f789-4afa-825d-e43792b395bb",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0c032185-c7e9-4b8d-87f2-2c31df9e107a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "06bee598-79af-47b1-bf5d-6a1801f9c57a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "481b822d-6104-42a1-b04d-7287f65b3fb6",
"db_currency_id": "a91ed1cc-a04b-4481-a243-8cb0326dab20",
"db_language_id": "1d96420f-15e5-44ce-ba54-93e8332aa02a",
"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-02-07T06:42:18.3130457+00:00"
},
"modified_dateutc": "2026-02-07T06:42:18.3130457+00:00"
},
"marketing_segment_id": "e48a165e-33d2-46b1-accb-158a0e4711b2",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b6aa1653-5931-4c6b-91bb-75b2e7434f90",
"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": "f88605f4-fbf4-450a-b635-be3a39579d2d",
"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": "077578f4-e23a-424f-ac3d-a4f1c41dbeb7",
"db_country_code": "sample string 28",
"feelist_id": "ec6117b5-50a4-42f1-9a6d-5513d2a4b902",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6a256ec7-f3c5-488a-bedc-994d9889a5f6",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ecd0826b-8795-44c5-8a11-06bba9ab1e81",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-07T06:42:18.3130457+00:00",
"db_currency_id": "02ccba33-60d6-4d9f-b945-c0ffffce765c",
"db_currency_code": "sample string 10"
},
"company_type_id": "33cc6141-7aff-4953-8600-9e888fbd5fbb",
"company_type_name": "sample string 32",
"company_type": {
"id": "2743ea74-1aa6-4fe1-8441-00c7e7a6354b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e3f57a0f-0f02-4cb5-9214-b88153bb8c75",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e2c76bfc-2235-4fa2-b65f-7dc116d9c5ab",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c93cef73-f31c-4d4a-9fe5-e3cc6e033214",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "54bb6f39-9884-49a7-b391-8f334369bbd1",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "feede6f2-0b99-4e12-8669-09a17187cafd",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-07T06:42:18.3130457+00:00"
},
"company_sector_id": "776df053-b3f2-4076-af37-deaa1a3fddf2",
"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": "b3e98a3d-7f2a-4896-be63-628163209b72",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "4fae7703-61a2-4bae-baeb-3611dfb1f6aa",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d9647c25-4117-4586-a950-c2f5d18e91ec",
"account_manager_user_code": "sample string 56",
"company_status_id": "3e5296b0-08f3-4e24-b901-607a1b14ebfd",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-07T06:42:18.3130457+00:00",
"id2": 60
},
"db_language_id": "a9415ee9-4351-4240-8db5-47c706ed10a0",
"db_language_code": "sample string 7",
"db_title_id": "1159b00b-b9da-40d4-bf2c-666ce3e92f23",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-07T06:42:18.3130457+00:00",
"create_date": "2026-02-07T06:42:18.3130457+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-02-07T06:42:18.3130457+00:00"
}