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": "a4183bbb-ce99-4802-a05a-5353d8e3d824",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0407b675-eb14-49d9-a005-d4b5e4b1fe50",
"company_code": "sample string 5",
"company": {
"id": "f22941ed-ff35-404e-a566-f13c7d7129fd",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-09T23:45:11.0232335+00:00",
"sales_territory_id": "de604833-5f84-4d76-988a-ac544f052af9",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "52e450db-87c2-4444-afe9-d0321d7a2fd2",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "24c83c49-1f77-4ed9-a75e-22afa8e89905",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3fbb6b89-ecd2-45ea-9af3-099ed018ecd2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dc0875c2-8752-4f47-9f3e-57fdfe6184f2",
"db_currency_id": "689f3227-406a-4816-9876-98569d128b50",
"db_language_id": "66048007-9526-4311-a214-3ad48f108041",
"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": "2025-10-09T23:45:11.0232335+00:00"
},
"modified_dateutc": "2025-10-09T23:45:11.0232335+00:00"
},
"marketing_segment_id": "ea4bfbc6-6041-4b69-a617-dea2160b0ade",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ee5e8f06-6341-40de-853e-0bfedded1722",
"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": "a2545df3-8bd4-4198-85ff-b04ed12574f6",
"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": "1197bdb8-d5fa-4f79-a2c9-8831fa8e632c",
"db_country_code": "sample string 28",
"feelist_id": "3b5081bd-af72-45f1-a8b0-b77565807a2c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ef61ac63-05f2-41af-9864-e08097cc1264",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e4418875-35cb-4975-8a32-48f0590411d4",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-09T23:45:11.0232335+00:00",
"db_currency_id": "ff574103-f597-485a-8d0e-3a2336242294",
"db_currency_code": "sample string 10"
},
"company_type_id": "2d4e95dd-e218-4351-986a-341c7b2255aa",
"company_type_name": "sample string 32",
"company_type": {
"id": "6bf5148c-abce-4ab8-9480-761839aaaab3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f89a9886-20db-4d37-ba67-25cbfa222025",
"sales_organization_code": "sample string 5"
},
"db_language_id": "2589e3f4-ce7f-4a80-8314-9be1e569165d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c0601891-dc4b-4378-b617-3b076275efdd",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "341d2fcb-7b73-449e-a36f-d3eefc8242d4",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "304aaa8a-eb4a-4f7a-9bed-3ba3592e7ea7",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-09T23:45:11.0232335+00:00"
},
"company_sector_id": "e3e9ad3b-4f89-40e4-92ab-e2898c90421d",
"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": "a2dcd8c0-ad13-4737-a3a2-98bcb4ee6249",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "8244b3bb-fad1-44e9-8795-ce46667d7f8b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8cc1496d-5e6b-4d31-a21d-ba862b831a2c",
"account_manager_user_code": "sample string 56",
"company_status_id": "9e3cb389-a8f7-4536-ad7a-2cd7e9df5704",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-09T23:45:11.0232335+00:00",
"id2": 60
},
"db_language_id": "7601d1c3-9d6c-44bc-88bf-60e00c894173",
"db_language_code": "sample string 7",
"db_title_id": "f132916a-acd0-44b9-83d2-6774d3c6b508",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-09T23:45:11.0232335+00:00",
"create_date": "2025-10-09T23:45:11.0232335+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": "2025-10-09T23:45:11.0232335+00:00"
}