Get a List by Key

Retrieve information about an existing list. A list is a named set of predefined values that a list-type field takes its value from, such as the priority, status, urgency or impact of a service record, or a custom list field. Only the lists of service records are found, the same lists that GET /lists returns. A key that is not a list answers 404, and so does the key of a service record field that is not list-typed, such as "title". The response holds the list's key and its display name, in the calling user's language, without the list's values. A list whose display name SysAid does not report is returned with an empty name.

Path Params
string
required
length ≥ 1
^[^,]+$

The key that identifies the list in SysAid, as returned in listKey by GET /lists, such as "priority" or the key of a custom list field. The key is matched exactly, including case. A key that contains a comma is rejected with 400.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json