Skip to main content
GET
List users

Authorizations

Authorization
string
header
required

Caller credential (Authorization: Bearer <token>). Required on protected routes when auth is enabled. Browser sessions may use the HttpOnly id_token or accessToken cookie instead.

Query Parameters

query
string

Case-insensitive substring match on email or display name.

Required string length: 1 - 200
limit
integer
default:25

Page size. Defaults to 25, max 100.

Required range: 1 <= x <= 100
page_token
string

Opaque token from a previous response next_page_token.

ids
string

Return only these users (comma-separated ids, up to 100). Users that are unknown or inactive are omitted. Cannot be combined with query or page_token.

Response

Paginated users.

data
object[]
required
pagination
object
required