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": "1ea3bce1-2540-47f5-b630-43ebdc1c3668",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "bca37148-d932-4bfc-883f-60a1850ce7ed",
"company_code": "sample string 5",
"company": {
"id": "09e9315d-b9d9-4b1d-9930-6e57282288a4",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-07T08:15:53.6054041+00:00",
"sales_territory_id": "a0f5199a-9b18-45ca-8b9a-3ebc0590c70c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "dffbd3f5-dfb7-4cec-9b10-72d83648bab5",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a6602c97-c462-4102-bfae-c96e12b9c606",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "04e7fe00-0068-4320-a411-a6870f85dc0f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "71a8a3ba-ee9a-43b6-b3a0-715675e78904",
"db_currency_id": "cd7c10a4-7295-4d80-a361-6642456343d6",
"db_language_id": "6e8b8aed-3211-4c21-a51e-9f6f3ffdd3c8",
"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-07T08:15:53.6054041+00:00"
},
"modified_dateutc": "2026-01-07T08:15:53.6054041+00:00"
},
"marketing_segment_id": "3809b132-3734-41a2-ba6a-adfca5730c6a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "2de124ea-376d-43ad-8eb7-ec97b90ea7ee",
"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": "b28478c5-b49c-40d1-811b-fe421fa8904a",
"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": "d2056bef-aa07-4275-a1a2-55e95694379b",
"db_country_code": "sample string 28",
"feelist_id": "6e2307df-b59e-4da1-872c-746c5fed1f27",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "244de8a7-95e1-4f63-aa4a-2ca522eb99bf",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f1a53921-57de-4173-ac83-aec3c0201a3f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-07T08:15:53.6054041+00:00",
"db_currency_id": "a757d3d5-c128-4b3a-a393-504d04443f53",
"db_currency_code": "sample string 10"
},
"company_type_id": "b95c2c2e-a16c-462c-9cc1-e83627655f51",
"company_type_name": "sample string 32",
"company_type": {
"id": "3fa8dddf-3e2c-4ba7-a540-64f91002e812",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "140e542a-a2ad-44d5-8453-1dcaf9c0d069",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e3d01e0e-78e0-472d-960a-4c286fdd91e8",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a665766e-e5eb-4f71-a712-2bfb1ae477d6",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f0d24c3e-2a7c-4d6f-8492-42b6967d9536",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e79d977b-3b2e-4c38-91d7-bf13150d33af",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-07T08:15:53.6054041+00:00"
},
"company_sector_id": "70939f59-b1a9-4ac3-9a4a-e91942337731",
"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": "b2dc149c-7110-4050-8683-de661a89d42e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2bf75160-7c27-482e-91a0-22f47b1b20ff",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8e9115f9-e8c4-4044-9109-b6e9db077ebc",
"account_manager_user_code": "sample string 56",
"company_status_id": "e4fc7769-3999-42f0-b7a9-f0a6ecb43e4e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-07T08:15:53.621029+00:00",
"id2": 60
},
"db_language_id": "1a0fa0e1-76d3-45e1-a664-3e8f7e77a5ca",
"db_language_code": "sample string 7",
"db_title_id": "c4283d9d-c87e-48e4-a612-c0bccdad2ab6",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-07T08:15:53.621029+00:00",
"create_date": "2026-01-07T08:15:53.621029+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-07T08:15:53.621029+00:00"
}