Skip to main content
GET
List groups
Returns a paginated list of all groups in the organization. Use search to find groups by name, and sort_by / sort_dir to control ordering. Archived groups are excluded by default. Groups exist at the organization level and are not scoped to a single program, so this endpoint returns all groups regardless of which programs they participate in.
For usage patterns and examples, see the Groups guide.

Authorizations

X-API-Key
string
header
required

API key passed in the X-API-Key header.

Query Parameters

limit
integer
default:50

Maximum number of results (default 50, max 200)

Required range: x >= 1
cursor
string

Pagination cursor from previous response

include_archived
boolean
default:false

Include archived groups

Search by group name (partial match)

sort_by
enum<string>

Sort field

Available options:
created_at,
name
sort_dir
enum<string>

Sort direction

Available options:
asc,
desc

Response

List of groups

data
object[]

Data contains the list of items

pagination
object

Pagination contains cursor information for fetching more results