List groups

GET

groups

curl --request GET \
  --url https://api.kohortpay.com/groups \
  --header 'Authorization: Bearer <token>'

{}

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

expand

string[]

Fields to expand related entities. For example, ["organization"].

take

number

Maximum number of items to retrieve. Default is 25.

Example:

10

skip

number

Number of items to skip before starting to collect the result set.

Example:

0

orderBy

string

Field to order the results by, followed by ":asc" or ":desc". For example, "createdAt:desc".

Example:

"createdAt:desc"

string

Search term to filter the results. Supports multiple terms with "~" for partial matches.

Example:

200 - application/json

Groups successfully retrieved.

The response is of type object.

curl --request GET \
  --url https://api.kohortpay.com/groups \
  --header 'Authorization: Bearer <token>'

{}