HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference

User Groups / Listing

Get all user groups

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

Send custom field criteria as literal dotted keys filter[customFields.<identifier>], not as nested filter[customFields][<identifier>] keys. Text, email, and URL fields accept a string matched as a case- and accent-insensitive substring, with %, _, and backslash treated literally. Boolean fields accept true, false, 1, or 0. Number, date, and date-time fields accept inclusive filter[customFields.<identifier>][from] and/or filter[customFields.<identifier>][to] bounds; when both are sent, from must not exceed to. Number bounds are decimal strings from -99999999999999.999999 through 99999999999999.999999 with at most six fractional digits and no rounding. Date bounds are YYYY-MM-DD calendar dates. Date-time bounds are ISO 8601 timestamps: offsets are normalized to UTC and an absent offset means UTC. Multiple identifiers combine with AND. Blank or null scalar criteria and ranges with both bounds unfilled have no effect, including for unknown dotted keys. Populated criteria for unknown, deleted, restricted, operator-inapplicable, disabled, or non-filterable fields return 400; malformed values for usable fields return 422. Custom-field criteria never return 404. Operator-scoped fields match only groups whose current operator owner makes the definition applicable.

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
Responses

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