Skip to main content
GET
List users

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Query Parameters

limit
integer<int64>
default:100

Limit the number of resources returned by the API

Required range: x >= 1
offset
integer<int64>
default:0

Offset the resources returned by the API

Required range: x >= 0
page
object

JSON:API pagination, as page[limit] and page[offset]. The same as the top-level limit and offset parameters; when both forms are sent, page[...] wins.

sort
enum<string>[]

A comma separated list of fields to sort by.

Available options:
email,
-email,
first_name,
-first_name,
last_name,
-last_name
filter
string
default:""

Filters the response data based on the value provided.

Available filters:

  • email: Filter by email address(es) (case insensitive)
  • name: Filter by name(s) - filters by first and last name (case insensitive)
  • combined: Filter by name(s) and email address(es) (case insensitive)
  • status: Filter by membership status. One of active, inactive, pending, unknown, or any (any returns all statuses). Defaults to active when omitted (org-scoped member listings only).
  • seat_class: Filter by seat class, one or more of full, field and record, such as seat_class(full,field). A membership stored before seat classes existed is full. Member listings only.
  • organisation: GET /v3/users only. The organisations to list, by id, such as organisation("<id>"), the id in quotes.
  • unmanaged: unmanaged(true) lists only members with no primary manager in the organisation. It combines with status, so by default it lists active members with no primary manager. Org-scoped member listings only, and it needs management-relationships:view across the organisation.

For more information on using named filters, see the docs

Response

Get a list of Users.

JSON API response object

data
A list of users · object[]
required
meta
object
required
jsonapi
object
required