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": "0a7a5fac-0f7a-4810-abc5-d555e8dd8b5d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "ef68ae43-65ec-41ce-9623-eba1a7f141ab",
"company_code": "sample string 5",
"company": {
"id": "d25e20d4-d080-4133-942c-6413c8e6c360",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-13T22:06:44.3979557+00:00",
"sales_territory_id": "41a2732f-bbb6-4bd8-bb0b-eababcfdfc21",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "42ff0792-8648-4088-9209-65ac7769356a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2fcb477b-10b1-4edd-8c6a-3ee9fe3298f4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "707da163-07b7-45e9-8824-21601adb8bbd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "94d10f3d-0be0-4e54-9f64-20bc2954c751",
"db_currency_id": "8c128dba-02e4-429e-b78a-124fe32827d4",
"db_language_id": "baeb7aae-2a65-499f-8e89-cf87135aa685",
"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-03-13T22:06:44.3979557+00:00"
},
"modified_dateutc": "2026-03-13T22:06:44.3979557+00:00"
},
"marketing_segment_id": "358b5d08-3d91-4728-ba2c-85a9d191d1db",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "3ec91c8b-f590-47f4-a111-a74d95216cf4",
"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": "4d1f6e7c-2547-46c4-ada8-39e23c8c5b75",
"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": "a46503c2-79d3-4a3c-9d81-8d7fb24b5dc2",
"db_country_code": "sample string 28",
"feelist_id": "a91874b1-65d6-41df-a6a6-b41642970202",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ae583916-c057-464a-ba94-fba17b027813",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b0e469d7-17c4-4cd9-aa02-ba99ac85d860",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-13T22:06:44.3979557+00:00",
"db_currency_id": "af9d5b78-4ce3-46e0-b503-055876c492b8",
"db_currency_code": "sample string 10"
},
"company_type_id": "4b3df768-8a76-4c1f-b460-01cdab08091b",
"company_type_name": "sample string 32",
"company_type": {
"id": "95bc307b-5e37-4957-8918-e77a0bc681dc",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0a1b83a4-4224-49e1-9e55-faf23b916654",
"sales_organization_code": "sample string 5"
},
"db_language_id": "811171ed-f28e-40e2-ba87-5f6a1b0d75f4",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "06bdeaf9-167b-4299-8296-4d0e7f02a77a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0e41fb68-d3e3-4d93-9e74-49c73c93ac71",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "960a9532-1d38-4ba1-a7b9-a6c24474f747",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-13T22:06:44.3979557+00:00"
},
"company_sector_id": "f72e6422-476f-4eee-8183-7bcd90cc8eda",
"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": "de4d4b57-bb2c-43a4-8909-4042a7d047a8",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1884c16e-c70d-4fba-a97a-ebf9b7728cb4",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "defb8b4c-a4f7-4708-8618-6bd3ebc8abbb",
"account_manager_user_code": "sample string 56",
"company_status_id": "08a7127a-4224-4c35-8bda-50bffb8d771f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-13T22:06:44.4121153+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": "7d328ba0-f7fa-485d-8469-9523d49e92ac",
"db_language_code": "sample string 7",
"db_title_id": "d51f5dd7-33ad-488a-b7b3-7d81889b5afa",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-13T22:06:44.4121153+00:00",
"create_date": "2026-03-13T22:06:44.4121153+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-03-13T22:06:44.4121153+00:00"
}