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": "43d86502-f239-4faf-8828-fd9c002c0ae2",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "849e9cfe-3bbb-4819-9891-4ad32a36f9bc",
"company_code": "sample string 5",
"company": {
"id": "4c00b94b-e563-4e54-920e-b4edb7320cf1",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-25T22:55:48.1097169+00:00",
"sales_territory_id": "48a4fdf4-9beb-4918-8c96-f3900c1ed862",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a70cf8b6-2b68-43f5-bd1c-91431ab125fc",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "63690c67-3ac3-4737-b134-18070464a89a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "44331a4a-dd96-46f3-b5ca-aae636444830",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ffd5db31-9856-414f-b97e-950e8d0c15d5",
"db_currency_id": "daecff69-7682-4930-a6dc-58503be5f593",
"db_language_id": "4d81b09f-e674-4b90-808e-b27424c5a3f3",
"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-01-25T22:55:48.1097169+00:00"
},
"modified_dateutc": "2026-01-25T22:55:48.1097169+00:00"
},
"marketing_segment_id": "ad5c41c8-9931-4d74-a9ff-ab26829926ca",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "77f560e8-ced0-4eac-acf1-74d2191b2def",
"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": "f7f6f8e3-49dd-4609-a3b1-feb353fc2a34",
"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": "f69c2fb2-7b8b-40a3-a478-b38341248166",
"db_country_code": "sample string 28",
"feelist_id": "ee1946c0-e00b-493d-8961-4a210170097f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "51e820a8-454a-45a6-b5b8-fab9257a6a26",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b84bd2dd-340a-4c65-8c52-e7a015a50cf2",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-25T22:55:48.1097169+00:00",
"db_currency_id": "8a1ec45a-a6f7-4a38-b493-ac4e446e5489",
"db_currency_code": "sample string 10"
},
"company_type_id": "37e65df7-3c3b-4097-8b5f-a93b5f57b036",
"company_type_name": "sample string 32",
"company_type": {
"id": "b2ea55de-c054-4311-800b-106eedbe61d3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a24c7e90-b136-41ca-9115-39c9aa22228c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "7e298267-876c-4763-867f-2f773755f6b2",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e659eaba-3a17-4fa7-9821-4e568d3a1a67",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "365b4a4c-3061-4891-ac5b-f9131834862a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d6979fc5-c8a4-4bf8-a3dc-e52b22ecead5",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-25T22:55:48.1097169+00:00"
},
"company_sector_id": "c65eb6bf-5b83-4ece-8e5e-5999e7f722a5",
"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": "2400ad73-933d-4306-b52e-0aa39c2724a2",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "da0af5db-9e44-4559-8aca-b0a45bef934d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c3868d93-d55c-4bfb-bc11-c8d7a0c37f0b",
"account_manager_user_code": "sample string 56",
"company_status_id": "d8915dff-975c-4b29-b720-6bcc7fc5bdb4",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-25T22:55:48.1097169+00:00",
"id2": 60
},
"db_language_id": "7237c4ae-e9fe-43ed-beac-bba8dc792644",
"db_language_code": "sample string 7",
"db_title_id": "b17c01d0-36c4-47e1-95af-48416cf65eba",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-25T22:55:48.1253437+00:00",
"create_date": "2026-01-25T22:55:48.1253437+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-01-25T22:55:48.1253437+00:00"
}