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": "04d201e8-7bf3-4e82-9111-fc5efa905958",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8911594d-9c78-4d79-b6de-9e05b4c12c5c",
"company_code": "sample string 5",
"company": {
"id": "2baa444e-ef3e-482c-bbb7-43823a590eda",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-26T18:20:38.7201239+00:00",
"sales_territory_id": "312c162d-5d29-4589-9498-d2aa7b2f7ad9",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f4540f11-f05d-4958-a3b0-4942bd988489",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "570f57f8-8a45-4c63-b2ad-9b32f3498494",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bd445d53-5569-4645-a09e-149ea92408a4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e5748b9d-c8b9-4c99-b6ab-a6049609e517",
"db_currency_id": "9c07fa4f-6990-4075-be51-21cc0abffed1",
"db_language_id": "051c1069-ba54-4e71-8199-856569eece7e",
"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-26T18:20:38.7201239+00:00"
},
"modified_dateutc": "2026-10-26T18:20:38.7201239+00:00"
},
"marketing_segment_id": "a04858a0-8a36-4364-8746-46d4f7427ba9",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4df466b6-4a64-47fa-8a40-22b8a0a95aaa",
"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": "470bcf15-2494-40fc-8f5a-79a66c2e0a04",
"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": "138bf350-195e-435e-86d0-b06df1819a1d",
"db_country_code": "sample string 28",
"feelist_id": "adc1ce34-d849-46ff-a928-4e68a6064dad",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "4b5c56e9-181d-40dc-b1b4-b0515a4f8f48",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "72ed966c-67db-47c7-a3d2-20a632257723",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-26T18:20:38.7201239+00:00",
"db_currency_id": "e82fbd67-9489-48d9-92cb-3b5bc0851c2b",
"db_currency_code": "sample string 10"
},
"company_type_id": "9d94a7d7-0954-472c-aba8-30dda3fbec02",
"company_type_name": "sample string 32",
"company_type": {
"id": "199d9bf9-bdcb-4822-aa88-aa1bb51e47a4",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1404bc7c-0a82-4630-b60f-79a3e9d83456",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1d17fc41-935f-4c6e-8070-54fa3c18c5e9",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c03e5d8a-ff71-4f86-862f-3ccdde3eb224",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f4f2fa25-e2fb-47c8-889f-83794f601bf0",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "19677d9f-8aff-4cbf-ac1d-ed7021f9470e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-26T18:20:38.7201239+00:00"
},
"company_sector_id": "80c60b48-ded2-48a7-95e2-ab58f44032b9",
"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": "e9036f7c-5f63-4c43-9239-b48200ffef84",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b9f59649-15a9-448b-94c1-f5f1b056cb1b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "51bdfdbe-6b0a-4e3a-9573-877bf1455d13",
"account_manager_user_code": "sample string 56",
"company_status_id": "8ba6960f-5cdd-4ca2-ba1f-5814a7f0c7ee",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-26T18:20:38.7201239+00:00",
"id2": 60
},
"db_language_id": "e9ba5ede-99ab-46ca-8fb6-3cb23258c324",
"db_language_code": "sample string 7",
"db_title_id": "44f098e5-b12d-461c-9dad-44491da1e208",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-26T18:20:38.7201239+00:00",
"create_date": "2026-10-26T18:20:38.7201239+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-26T18:20:38.7201239+00:00"
}