List user lists
UserList
List user lists
Returns all user lists for the current tenant. User lists can be static (manually curated) or dynamic (criteria-based). Requires HR_TENANT or COMMUNICATION_TENANT permission.
GET
List user lists
Authorizations
Server-to-server authentication. Generate a token in the admin UI at
Settings → Developers → API Access. Send the raw token in the
Api-Token header — there is no Bearer prefix.
Tokens can be marked read-only at creation time, in which case the API
rejects any non-GET request with 403 Forbidden.
Query Parameters
The collection page number
The number of items per page
Required range:
0 <= x <= 100Enable or disable pagination
Available options:
asc, desc Available options:
asc, desc Available options:
asc, desc Response
UserList collection
Available options:
static, dynamic Example:
"/api/v1/tenants/1"
Available options:
members_and_contacts, members_only, contacts_only Available options:
ALL, ACTIVE, INACTIVE Maximum string length:
1000
