Skip to main content
GET
Get a user list

Authorizations

Api-Token
string
header
required

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

id
string
required

UserList identifier

Response

UserList resource

type
enum<string>
default:static
required
Available options:
static,
dynamic
id
integer
read-only
tenant
string<iri-reference>
Example:

"/api/v1/tenants/1"

name
string
createdAt
string<date-time>
read-only
owner
object | null
criteria
(string | null)[] | null
scope
enum<string> | null
Available options:
members_and_contacts,
members_only,
contacts_only
memberStatus
enum<string> | null
default:ACTIVE
Available options:
ALL,
ACTIVE,
INACTIVE
descriptionPrompt
string | null
Maximum string length: 1000