Retrieve lists

Retrieves a collection of lists. This operation returns the most recent version of each list.

SecuritySecretApiKey or JWT
Request
query Parameters
limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer >= 0

Specifies the starting point within the collection of items to be returned.

filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

sort
Array of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -.

fields
string

Limits the returned fields to the specified list, each field separated by a comma. The ID value is always returned.

q
string

Use this field to perform a partial search of text fields.

Responses
200

Collection of lists retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example: 2
Response Schema: application/json
Array
description
required
string

Description of the list.

values
required
Array of strings

Values in the list.

id
string <= 50 characters

ID of the list.

version
integer >= 1

Version of the list.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

Array of objects (Self) non-empty

Related links.

Array (non-empty)
href
required
string

Link URL.

rel
required
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/lists
Request samples
// all parameters are optional
const firstCollection = await api.lists.getAll();

// alternatively you can specify one or more of them
const params = {limit: 20, offset: 100, sort: '-createdTime'}; 
const secondCollection = await api.lists.getAll(params);

// access the collection items, each item is a Member
secondCollection.items.forEach(list => console.log(list.fields.name));
Response samples
application/json
[
  • {
    }
]