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": "2d2760d2-02b1-4aa5-988b-04630bb62b5f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2e6c1678-cb00-424d-80f8-2d805925b462",
"company_code": "sample string 5",
"company": {
"id": "a5c2f763-70be-4d0d-aa58-9058ea4dd664",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-18T03:13:46.3328253+00:00",
"sales_territory_id": "38fb3461-1fb4-41f7-b16b-2e2d163c1a3d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "494b5efc-94b3-4b52-acc2-db6d998f3ff8",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1c964cd3-47d0-417c-9f8c-e91527c81bb4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5ae45078-bcbd-4fd9-ba43-8e68a8e46e8d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0935f1ba-cc49-4fb3-8ec7-2152a8869777",
"db_currency_id": "1249b247-bcf7-4a4e-ba6e-50299214cabd",
"db_language_id": "c38447d1-088b-4f52-a3b4-41a0e22d9b0a",
"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-18T03:13:46.3328253+00:00"
},
"modified_dateutc": "2026-01-18T03:13:46.3328253+00:00"
},
"marketing_segment_id": "5d957995-7a3e-4a40-bec0-990dd27d08ab",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d1e6502a-d214-4df4-978f-423f2d9aec8e",
"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": "24603b6f-45dc-420d-8e46-c0181cedb4db",
"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": "4daf327d-c180-48ee-89f5-7a5c6bbede63",
"db_country_code": "sample string 28",
"feelist_id": "1e3145c1-3b14-4d2f-bebb-5d5c113db247",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "4eb9f1b3-686f-47e9-94c7-f229db68512a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "18435e9b-0a29-454a-8efd-8e6350ab256e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-18T03:13:46.3328253+00:00",
"db_currency_id": "38329e7b-63f7-4193-8847-4829559d109d",
"db_currency_code": "sample string 10"
},
"company_type_id": "6049eb4f-5176-46a1-8a70-1ecb72abe494",
"company_type_name": "sample string 32",
"company_type": {
"id": "13dc945c-1499-4d22-b5fc-64e4516f58de",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2fc96075-2ab7-4fcb-8f7a-888921b81565",
"sales_organization_code": "sample string 5"
},
"db_language_id": "08003b40-568d-43aa-bb17-f5171d4b9e0b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a69cd293-592c-4354-bc71-e432d1dbc5a4",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c2803774-3cc1-43e7-82b8-d2a6a4abe80f",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0b9498c7-b841-4dfb-8a4b-20a9fc43eaac",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-18T03:13:46.3328253+00:00"
},
"company_sector_id": "d884c26a-2fe3-4f28-8d5f-0ba992d4fb11",
"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": "a14de18a-e9bb-4843-8ee3-865951bc6f15",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "13bbabde-bb2e-4dd5-a7c3-a642e6b5f762",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9017a3ce-394d-4fc9-a2a3-e6df40e8b2c8",
"account_manager_user_code": "sample string 56",
"company_status_id": "7636a7d9-7e75-4b9c-b27d-57a32b4773cf",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-18T03:13:46.3328253+00:00",
"id2": 60
},
"db_language_id": "a00936dd-c459-4ae8-bbaf-a222aad45d67",
"db_language_code": "sample string 7",
"db_title_id": "b1f6ec5b-cdb3-4ee9-a3d0-9cf5642686a0",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-18T03:13:46.3328253+00:00",
"create_date": "2026-01-18T03:13:46.3328253+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-18T03:13:46.3328253+00:00"
}