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": "ce73ec92-0dc3-4c91-86b6-50e79900aeec",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "96e664f5-9e56-41cb-8bcd-87b7b88870e8",
"company_code": "sample string 5",
"company": {
"id": "e5bf1748-b489-4bfb-978a-899a918e929d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-16T05:12:45.29175+00:00",
"sales_territory_id": "931fec96-4d66-4947-a03d-fae768f18964",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "06518617-0231-445e-8753-40fb75a4adc6",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5eab6741-e1c1-4c7a-95b4-e1cb085074a5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "37e3ed4c-4b3a-4d41-88b3-d3f96ccfe269",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8e804c70-4426-4f63-bff2-83cb21f83e66",
"db_currency_id": "2f0cfa55-388e-438f-8463-7a1b349b317a",
"db_language_id": "cfa204fc-d2eb-4e9a-87be-d49aecbeaee2",
"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-16T05:12:45.29175+00:00"
},
"modified_dateutc": "2026-02-16T05:12:45.29175+00:00"
},
"marketing_segment_id": "44955654-9be0-4d7f-9f7b-7bd8478c9fb8",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7dea871f-7193-48d2-aa64-7fe9e09ee003",
"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": "94bf19e5-0602-4a60-9967-ee41c5f6a16a",
"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": "52cd32c5-5ebf-43ad-8796-feab7d77fce5",
"db_country_code": "sample string 28",
"feelist_id": "2f876375-3f26-478f-b19c-e2a375fb4012",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "591a6e5e-2956-4908-80c4-d242c9719d8d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d3c44ff2-bcad-4cd7-b60d-d0b7267a13aa",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-16T05:12:45.29175+00:00",
"db_currency_id": "415eaa81-cf1d-4751-b0fb-0c7f876c1233",
"db_currency_code": "sample string 10"
},
"company_type_id": "451dfdda-aec2-4513-a702-8d29ab46c140",
"company_type_name": "sample string 32",
"company_type": {
"id": "31b95441-42c4-4cc4-baf3-1680df7295a5",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f81e5be9-c9dc-440f-a475-4d04cb1d9ef3",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1b8c766d-eac2-420b-9d2c-424e6fc6c4c7",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d2c6d7a8-7522-4726-a0e4-35e5183dcd96",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f54f6bb5-f283-4fa4-8a12-1956b7e338af",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "1a5214e8-7a84-4456-806e-4e88f99aa0eb",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-16T05:12:45.29175+00:00"
},
"company_sector_id": "4611d6ac-e153-45ae-b76a-1a0beeadfd76",
"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": "7a91eb68-3343-4c25-8593-1209a293dbcf",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "0cabcba9-2b62-4f19-8ec0-02ac7c0cbb8d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e1c4610e-8b4a-4bb6-b756-c52cc4b47923",
"account_manager_user_code": "sample string 56",
"company_status_id": "d853bbad-be9b-4b1f-a7fa-3a59574bcb41",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-16T05:12:45.29175+00:00",
"id2": 60
},
"db_language_id": "88138d65-5e57-4931-afcb-0f0af2151f1d",
"db_language_code": "sample string 7",
"db_title_id": "2a8709bf-5cde-4fcc-b43b-06fe564f186c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-16T05:12:45.29175+00:00",
"create_date": "2026-02-16T05:12:45.29175+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-16T05:12:45.29175+00:00"
}