Retrieves the contact with the specified key
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult
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": "577623b3-9840-424d-a654-08bed4ec0405",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "f8a546c1-f18b-4eb4-9bf6-d27d6660ab03",
"company_code": "sample string 5",
"company": {
"id": "7a72adf1-0b8e-464c-aedc-96612b42f2b9",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-03T04:58:26.25298+00:00",
"sales_territory_id": "6db75eef-eeb0-4ba4-bd8e-058870596f9c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "8eeaf453-84c1-4f11-94a0-12ce140ba1b7",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d9079150-a8de-4739-8ea7-a03bc0e4cfe3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5ab9c897-9155-45c8-809d-b5daa4f2b171",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9a08a6f3-7ba0-4eed-b6a8-a06b3467b181",
"db_currency_id": "983a7f6a-4a81-4e54-8d1b-b186f3b9701e",
"db_language_id": "1eafc973-bec0-4891-b3db-423cd18ff853",
"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-04-03T04:58:26.25298+00:00"
},
"modified_dateutc": "2026-04-03T04:58:26.25298+00:00"
},
"marketing_segment_id": "aa448a3a-b3f7-42c8-8475-c39b03416b11",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "457b998d-ac54-4de1-9790-146a97c88024",
"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": "b3206d4a-116a-4df1-b153-9ea41940bf7b",
"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": "8eb0fa72-0ba2-44ad-81f4-00f4dc8015e0",
"db_country_code": "sample string 28",
"feelist_id": "864c5170-00fe-4a18-8269-2857cf0da0b6",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "4da21919-f396-4ff8-81fc-a6c3212a1741",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "3fc6c07d-e1cc-4776-8567-a06a3845dd52",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-03T04:58:26.2686365+00:00",
"db_currency_id": "544cc23d-b0ba-45a2-abc9-a948197c7885",
"db_currency_code": "sample string 10"
},
"company_type_id": "bda4d486-e9ea-4cc1-b4d7-a40048b4bc44",
"company_type_name": "sample string 32",
"company_type": {
"id": "d24d3a3b-1da2-42a9-be27-aa9c6c7bd861",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "dc1ce9ad-03ee-4130-9294-d269361e51ca",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f9755786-0eb9-4344-8557-35d890304ca3",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "84a06085-6e47-4e63-a486-d1553d319cde",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "073b5c7a-a19a-454a-8398-93527c786cce",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "fbc64658-3355-46b0-9b22-78fd9be78898",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-03T04:58:26.2686365+00:00"
},
"company_sector_id": "fea78063-b5af-4b3a-bbb9-6adbd662bf84",
"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": "41726409-3d53-49dd-94c3-98d4fd4ab3a9",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "c832f187-a6fc-4d9f-bd97-3e30d3bd107c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e72af7b4-885c-4b23-afae-8ad54ef427be",
"account_manager_user_code": "sample string 56",
"company_status_id": "b36ea54b-05a3-4590-aca4-b70616b777d7",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-03T04:58:26.2686365+00:00",
"id2": 60
},
"db_language_id": "7fe87d5a-108a-4876-818c-fb96bb6e28fd",
"db_language_code": "sample string 7",
"db_title_id": "8fdb3a13-7239-4187-becd-0f1f2e3707e2",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-03T04:58:26.2686365+00:00",
"create_date": "2026-04-03T04:58:26.2686365+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-04-03T04:58:26.2686365+00:00"
}