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": "2a99e9f7-83b7-4ddf-8cbe-886659275cbb",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d92f6c2c-4f47-4da5-bd19-34bf90005ede",
"company_code": "sample string 5",
"company": {
"id": "6b1886fb-81a6-454e-b9f7-7454e6fc33bb",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-20T08:38:21.2156026+00:00",
"sales_territory_id": "84659d3d-2d3b-43ae-8544-ecce8fd2fd3d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f153e00e-5401-4a10-93dd-0380dd8a0887",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "491ba260-9737-435e-be4a-7883a1b6a67f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "84c6541b-ba55-487c-9a9d-233082061c6a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5f71afde-e14f-494c-97dc-1bcef9fface6",
"db_currency_id": "43894c2e-35ae-418c-942d-5f9499dbb55e",
"db_language_id": "4ef1d405-d60c-4f47-adcf-3188dd411199",
"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-09-20T08:38:21.2156026+00:00"
},
"modified_dateutc": "2026-09-20T08:38:21.2156026+00:00"
},
"marketing_segment_id": "2bed9a7f-15b5-4453-9b8a-66110185618a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "1d4a48a9-db54-4f7c-89d2-f34ee7b31b7b",
"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": "470e8478-115d-4d58-a034-39da76dc62ca",
"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": "44b2cdb2-3110-4908-9400-c77cd535559e",
"db_country_code": "sample string 28",
"feelist_id": "6920b543-0f81-45df-a25d-df251d2d0d55",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a972d660-092e-420b-bf30-0edfc90d60e6",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "83328ff1-475a-4988-bbf4-d46c43b38d49",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-20T08:38:21.2156026+00:00",
"db_currency_id": "590a4be0-79b6-48ef-b156-9a2eb557992b",
"db_currency_code": "sample string 10"
},
"company_type_id": "ece8a13e-63e5-41e2-bed5-a9c7a26a9439",
"company_type_name": "sample string 32",
"company_type": {
"id": "575a76b4-f925-4a07-aa4d-cb60beb2542b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f63dfd16-72b7-4ac2-ac46-2572f32bab86",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a022b10a-39f1-4b0e-8110-430e82b039f0",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "ae1c0ba7-2407-4702-9a5e-27cb79de73cf",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "55bbe08f-fcc3-4042-804a-affcdd37ad0e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "340aee56-e65a-4a25-a777-7ff1b880cc46",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-20T08:38:21.2156026+00:00"
},
"company_sector_id": "6efa0d7b-7365-4377-b79f-4064d0ed9364",
"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": "2eedb85a-5126-475b-8ef6-2732c6421364",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e802d1b4-5f9e-4023-be9c-cedf112de14e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c93b4d8e-649e-4c2e-a80d-e665c632faca",
"account_manager_user_code": "sample string 56",
"company_status_id": "dcb7a806-a4b0-420e-b9f2-0dfadc6ed8b9",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-20T08:38:21.2156026+00:00",
"id2": 60
},
"db_language_id": "154fd7e1-3a8d-443e-a07f-403d249fdbe3",
"db_language_code": "sample string 7",
"db_title_id": "6eb35276-bb1e-4d07-a7d4-54845c96358e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-20T08:38:21.2156026+00:00",
"create_date": "2026-09-20T08:38:21.2156026+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-09-20T08:38:21.2156026+00:00"
}