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": "6f428d6d-524c-4a22-b912-b00ab975d4e7",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "5a6e388b-d2a4-431f-b3f0-409bcb812b59",
"company_code": "sample string 5",
"company": {
"id": "a5ac2f11-bbf1-4e63-8174-3dbdd6362ed6",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-04T23:20:55.3740971+00:00",
"sales_territory_id": "b9d660cc-6b91-4fa8-8a15-10c72e919616",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9a8083bc-b222-4767-80f8-6b7689cb4671",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "51d5c99c-9081-46b6-8dbf-cc7d8fadcefc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a696c1b7-c72a-4a53-b7c0-5f60c511ebe9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "47e710aa-8705-4869-baef-a53eb20ed05e",
"db_currency_id": "3a289d76-15e4-4999-bcdc-b686bf2303b2",
"db_language_id": "1d2a6467-71f4-4112-8861-0bbfed8b1639",
"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-08-04T23:20:55.3740971+00:00"
},
"modified_dateutc": "2026-08-04T23:20:55.3740971+00:00"
},
"marketing_segment_id": "d96555ca-d47f-4f37-9f66-df313281ef18",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "027fea2d-11a7-4399-b649-7a600ff17195",
"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": "188c9e77-065b-4acc-b5f3-4e98ab892363",
"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": "cf75f0cc-0fa5-4ea6-9c48-f01b03adbb9d",
"db_country_code": "sample string 28",
"feelist_id": "317107a6-2257-4e57-9d3f-ba4ff30b57e8",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b7991ec8-d395-4d8c-995c-75b6735389e7",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e8ac751e-6cc0-4e95-8a67-e184132c91e8",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-04T23:20:55.3740971+00:00",
"db_currency_id": "e1d3ae23-e42f-4662-94ba-882625270591",
"db_currency_code": "sample string 10"
},
"company_type_id": "098d8d99-d60b-4732-b8fa-8c56e8ae7148",
"company_type_name": "sample string 32",
"company_type": {
"id": "7a0e2392-4e2f-4f21-9d94-607b7d6a28e8",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ed5a7bbd-7348-44c9-9ee2-be78e16e20d3",
"sales_organization_code": "sample string 5"
},
"db_language_id": "46bdb14c-7281-4939-a19d-3416ff301a4e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "ce7336e0-6a51-442b-be54-e4afb625d4fe",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "ce5974f6-45be-4516-97c1-9106b61299aa",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "214f60ed-cb03-4080-8299-2170c0d36463",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-04T23:20:55.3740971+00:00"
},
"company_sector_id": "bf39d4d9-60a3-48eb-a976-9ed2832e1687",
"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": "043669c0-64ed-4d39-af22-69b49fe04704",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b15b80c9-b305-44eb-ae48-8ed7aec4fa5b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "fd6b8526-048f-4504-83b3-576e1e9ab3fc",
"account_manager_user_code": "sample string 56",
"company_status_id": "22094b1d-4b04-463b-a5c7-1d01bc77cabf",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-04T23:20:55.3740971+00:00",
"id2": 60
},
"db_language_id": "df5b7381-208f-483e-a627-71b707964e09",
"db_language_code": "sample string 7",
"db_title_id": "c2d2b298-cb33-45b2-8690-8a3629afc7cd",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-04T23:20:55.3740971+00:00",
"create_date": "2026-08-04T23:20:55.3740971+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-08-04T23:20:55.3740971+00:00"
}