List Groups

Retrieve a paginated list of groups with filtering, sorting, and searching.

Authentication

Required Scope: groups:read

Query Parameters

Pagination

Parameter	Type	Default	Description
`page`	integer	1	Page number
`per_page`	integer	15	Items per page (max: 100)

Sorting

Parameter	Type	Description
`sort`	string	Comma-separated sort fields. Prefix with `-` for descending order

Allowed sort fields: name, created_at, updated_at

Searching

Parameter	Type	Description
`search`	string	Search across name (partial match)
`q`	string	Alias for `search`

Filtering

Use filter[field] for exact match or filter[field][operator] for complex filters.

Allowed filter fields: filter[created_at]

Complex filter operators: gte (>=), lte (<=), gt (>), lt (<), ne (!=), like, in, not_in, between, null

Response

Success (200 OK): Returns a paginated array of group objects.

Pagination Meta

The meta.pagination object contains:

Field	Type	Description
`total`	integer	Total groups matching filters
`count`	integer	Number on current page
`per_page`	integer	Items per page
`current_page`	integer	Current page number
`total_pages`	integer	Total number of pages
`has_more`	boolean	Whether more pages exist

Error Responses

Status	Code	Description
500	`INTERNAL_ERROR`	Failed to fetch groups

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

curl --location -g --request GET '/groups?page=1&per_page=15&sort=-created_at&search=VIP&q=VIP&filter[created_at][gte]=2025-01-01&filter[created_at][lte]=2025-12-31' \ --header 'Authorization: Bearer <token>'

Authentication#

Query Parameters#

Pagination#

Sorting#

Searching#

Filtering#

Response#

Pagination Meta#

Error Responses#

Request

Responses