Get a user list
UserList
Get a user list
Retrieves a single user list by its identifier, including its type, criteria, and scope configuration. Requires HR_TENANT or COMMUNICATION_TENANT permission.
GET
Get a user list
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.
Path Parameters
UserList identifier
Response
UserList resource
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
