Skip to main content
GET
List / Find Users

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer

Page number (if paging results).

membership_status
enum<string> | null
default:ACCEPTED

Membership status in the API key organization. Omitted, null, or empty defaults to ACCEPTED. LOBBY requires the organization-level use-api-lobby-users entitlement; no additional API-key scope is required. Other values return 422.

Available options:
ACCEPTED,
LOBBY
name_like
string

A name, or part of a name, to search for. This searches both the first and last name.

email_like
string

An email address, or part of an address, to search for.

created_before
string<date-time>

Date the User account was created on or before.

created_after
string<date-time>

Date the User account was created on or after

updated_before
string<date-time>

Date the user was updated on or before.

updated_after
string<date-time>

Date the user was updated on or after

Response

Returns the paginated list of users in the selected membership status for the API key organization. Includes pagination links and meta fields; a search with no matches returns an empty data array.

data
object[]

Pagination navigation links returned on every paginated list response. Each URL points at the specific list endpoint being called.

meta
object

Pagination metadata returned on every paginated list response.

Last modified on September 24, 2026