HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference

Users / Listing

Get all users

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
filter
object

Filter by user properties or applicable custom field values. For custom fields, add one extra top-level filter entry named customFields.<identifier> per criterion, for example filter[customFields.invoiceReference]=INV-42. Custom-field criteria combine with the user filters using AND.

Operator-scoped criteria match only users whose current operator owner is assigned to the field; retained values from inapplicable definitions do not match. Non-empty unknown, inaccessible, disabled, deleted or non-filterable custom-field keys return 400 naming the rejected keys; malformed values for usable fields return 422. Custom-field filters apply only to listings, not search.

integer
Defaults to 1
deprecated

DEPRECATED - Sunset date: Mon, 01 Jun 2026

The page number to fetch (defaults to 1). Not used in cursor pagination.

This parameter is deprecated and will be removed on Mon, 01 Jun 2026.

Use cursor pagination instead for better performance and consistency. See the cursor parameter below for details.

integer
1 to 100
Defaults to 100

The numbers of items to return. Used in both page and cursor pagination to declare the page size.

string

The cursor to fetch the next page.

Do not construct this value manually. Use one of the following methods:

  • Use the value from the previous response's links.next to fetch the next page
  • Pass an empty string (e.g., ?cursor or ?cursor=) to initiate cursor pagination on the first page
include
array of strings
include
Allowed:
Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json