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": "6e1890f9-7388-40b5-aa08-dd2fed65feff",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4d26498b-15aa-4369-83ef-ae521dff0070",
"company_code": "sample string 5",
"company": {
"id": "ee4cf9ad-a912-44f9-bee6-bd2f7c657cc6",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-13T20:41:50.5154181+00:00",
"sales_territory_id": "1f939252-92c5-4110-a88d-e7f3d957496b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "fd4df599-24ec-46fa-8ef6-f96be0cc677f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ea5af14b-2419-4e02-bb49-6071cbc2bf77",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "138d36dc-19be-41df-8c97-466889ab41a2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "797b659e-39e6-4a75-8121-369fba04fb6e",
"db_currency_id": "a429488c-7ade-434d-8021-eda55453c070",
"db_language_id": "fe529912-06b3-42ef-9cb1-44a395ce8f07",
"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": "2025-10-13T20:41:50.5154181+00:00"
},
"modified_dateutc": "2025-10-13T20:41:50.5154181+00:00"
},
"marketing_segment_id": "fb02fb48-7c3a-4d5e-a4f3-b0fa1439cf6a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "111f2ab9-9786-4acd-8c8f-3a9cbe3994f9",
"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": "12876507-40ce-4407-bf50-5104ecdd509f",
"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": "c364f84e-4558-4f3b-8d90-a7a5c6f6302e",
"db_country_code": "sample string 28",
"feelist_id": "a09bff5a-0922-4d89-9c93-e8e40b8e6360",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "984de628-0716-46b8-90f2-01bea93e8c94",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5a4e61e0-29cc-44b3-b1db-9b475320c121",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-13T20:41:50.5335237+00:00",
"db_currency_id": "437e4cb9-f961-48f5-81c9-c82ac14896fc",
"db_currency_code": "sample string 10"
},
"company_type_id": "d8efad7e-c373-404b-971a-6147650448f2",
"company_type_name": "sample string 32",
"company_type": {
"id": "cb063073-3331-46ba-976a-3a6504245656",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9480db34-ee22-4a4a-8c65-b7f0f20a83de",
"sales_organization_code": "sample string 5"
},
"db_language_id": "cae3f7c6-50c5-4d4f-b3b0-81b54b62a8e7",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e78eaafe-5907-47d6-b1bd-6cd94262b472",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "9637eb09-e43f-4ade-879c-b06b28526e1d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "941d7926-cd97-4039-b48d-e9e28a9f9480",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-13T20:41:50.5335237+00:00"
},
"company_sector_id": "aee699ca-b402-42ca-997c-a7e658a8e69d",
"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": "4cc37552-3399-4b00-9043-3078dc1e2c82",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b1dcd208-6262-4347-9402-5273dea3cc2b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "171eaa86-e79f-4300-8e98-e655a0582ad9",
"account_manager_user_code": "sample string 56",
"company_status_id": "fe864a68-fa0a-4cdb-aebe-cb749a402f6e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-13T20:41:50.5335237+00:00",
"id2": 60,
"udf1": "sample string 61",
"udf2": "sample string 62",
"udf3": "sample string 63",
"udf4": "sample string 64",
"udf5": "sample string 65",
"udf6": "sample string 66",
"udf7": "sample string 67",
"udf8": "sample string 68",
"udf9": "sample string 69",
"udf10": "sample string 70",
"udf11": "sample string 71",
"udf12": "sample string 72",
"udf13": "sample string 73",
"udf14": "sample string 74",
"udf15": "sample string 75",
"udf16": "sample string 76",
"udf17": "sample string 77",
"udf18": "sample string 78",
"udf19": "sample string 79",
"udf20": "sample string 80",
"udf21": "sample string 81",
"udf22": "sample string 82",
"udf23": "sample string 83",
"udf24": "sample string 84",
"udf25": "sample string 85",
"udf26": "sample string 86",
"udf27": "sample string 87",
"udf28": "sample string 88",
"udf29": "sample string 89",
"udf30": "sample string 90",
"udf31": "sample string 91",
"udf32": "sample string 92",
"udf33": "sample string 93",
"udf34": "sample string 94",
"udf35": "sample string 95",
"udf36": "sample string 96",
"udf37": "sample string 97",
"udf38": "sample string 98",
"udf39": "sample string 99",
"udf40": "sample string 100",
"udf41": "sample string 101",
"udf42": "sample string 102",
"udf43": "sample string 103",
"udf44": "sample string 104",
"udf45": "sample string 105",
"udf46": "sample string 106",
"udf47": "sample string 107",
"udf48": "sample string 108",
"udf49": "sample string 109",
"udf50": "sample string 110",
"udf51": "sample string 111",
"udf52": "sample string 112",
"udf53": "sample string 113",
"udf54": "sample string 114",
"udf55": "sample string 115",
"udf56": "sample string 116",
"udf57": "sample string 117",
"udf58": "sample string 118",
"udf59": "sample string 119",
"udf60": "sample string 120",
"udf61": "sample string 121",
"udf62": "sample string 122",
"udf63": "sample string 123",
"udf64": "sample string 124",
"udf65": "sample string 125",
"udf66": "sample string 126",
"udf67": "sample string 127",
"udf68": "sample string 128",
"udf69": "sample string 129",
"udf70": "sample string 130",
"udf71": "sample string 131",
"udf72": "sample string 132",
"udf73": "sample string 133",
"udf74": "sample string 134",
"udf75": "sample string 135",
"udf76": "sample string 136",
"udf77": "sample string 137",
"udf78": "sample string 138",
"udf79": "sample string 139",
"udf80": "sample string 140",
"udf81": "sample string 141",
"udf82": "sample string 142",
"udf83": "sample string 143",
"udf84": "sample string 144",
"udf85": "sample string 145",
"udf86": "sample string 146",
"udf87": "sample string 147",
"udf88": "sample string 148",
"udf89": "sample string 149",
"udf90": "sample string 150",
"udf91": "sample string 151",
"udf92": "sample string 152",
"udf93": "sample string 153",
"udf94": "sample string 154",
"udf95": "sample string 155",
"udf96": "sample string 156",
"udf97": "sample string 157",
"udf98": "sample string 158",
"udf99": "sample string 159",
"udf100": "sample string 160"
},
"db_language_id": "6445b205-6709-44fa-8627-9c864fa3808f",
"db_language_code": "sample string 7",
"db_title_id": "70376c5d-d527-4331-b828-9de03ab847be",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-13T20:41:50.5335237+00:00",
"create_date": "2025-10-13T20:41:50.5335237+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": "2025-10-13T20:41:50.5335237+00:00"
}