Get a List of List Values

Retrieve a paginated list of the values of an existing list in your SysAid account. 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, and a key that is not a list answers 404. Each item holds the ID of a value and its caption, in the calling user's language. The values are returned in the order SysAid keeps them in, which is meaningful, such as priorities from 1 to 5. SysAid returns only the values that the calling user is allowed to see, so two users can get different values for the same list. A value with the ID "-1" may appear and is returned like any other value. SysAid's values are read in full and "limit" and "offset" are applied by the API, so "total" is the number of values of the list. At most 10,000 values of a list are read, so a list with more values returns its first 10,000 only.

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.

Query Params
integer
≥ 0
Defaults to 0

The offset for pagination. Calculated as (page - 1) * limit (page starts at 1).

integer
1 to 500
Defaults to 100

The number of items to display per page. The default is 100, and you can have up to 500.

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