Skip to main content
GET
List
For the complete error reference, see Error Guide.

Authorizations

apikey
string
header
required

API Key with fullAccess scope(i.e. Rest API Key from the Dashboard).

Headers

onBehalfOf
string

UID of the user on whose behalf the action is performed.

Query Parameters

searchKey
string

Searches for given keyword in group's list (either GUID, name or email).

searchIn
string[]

Searches for specified keyword in name,GUID or both.

sortBy
enum<string>

Sorts the group list by either Name,Guid or Created at . Available values: name, guid, createdAt

Available options:
name,
guid,
createdAt
sortOrder
enum<string>

Sorts the group list in ascending or descending order. Available values: asc, desc

Available options:
asc,
desc
perPage
integer
default:100

Number of groups to be fetched in a request. The default value is 100 and the maximum value is 1000.

affix
enum<string>

Determines whether to fetch the groups either before or after createdAt/updatedAt timestamp. Possible values are append(after) and prepend(before).

Available options:
append,
prepend
updatedAt
integer

Fetches the groups list after a particular updatedAt timestamp.

withTags
boolean

Includes those groups that have tags.

tags
string[]

Fetches only those groups that have these tags.

type
enum<string>

Fetches groups based on group type(public, protected, password).

Available options:
public,
private,
protected
types
string[]

Fetches groups based on multiple types.

page
integer

Page number.

hasJoined
boolean

Fetches all the joined groups of a user. This will work only with onBehalfOf parameter in header. It accepts only true as a value, setting it as false simply removes this filter.

guid
string

Filter groups by a specific GUID. Accepts a single GUID value.

guids
string[]

Filter groups by multiple GUIDs. Accepts comma-separated GUID values.

createdAt[from]
integer

Filter by createdAt start timestamp (Unix timestamp). Filters groups created on or after this timestamp. Can be used with createdAt[to] for a date range.

Example:

1738368000

createdAt[to]
integer

Filter by createdAt end timestamp (Unix timestamp). Filters groups created on or before this timestamp. Can be used with createdAt[from] for a date range.

Example:

1739059200

updatedAt[from]
integer

Filter by updatedAt start timestamp (Unix timestamp). Filters groups updated on or after this timestamp. Only returns groups that have actually been updated (excludes groups where updatedAt equals createdAt). Can be used with updatedAt[to] for a date range.

Example:

1738368000

updatedAt[to]
integer

Filter by updatedAt end timestamp (Unix timestamp). Filters groups updated on or before this timestamp. Only returns groups that have actually been updated (excludes groups where updatedAt equals createdAt). Can be used with updatedAt[from] for a date range.

Example:

1739059200

membersCount[gte]
integer

Filter groups by members count using comparison operators. Supported operators: gt (greater than), gte (greater than or equal), lt (less than), lte (less than or equal), eq (equal). Example: membersCount[gte]=2&membersCount[lte]=10 for a range.

Example:

2

membersCount[lte]
integer

Filter groups with members count less than or equal to this value.

Example:

10

membersCount[eq]
integer

Filter groups with members count equal to this value.

Example:

5

Response

200 - application/json

A list of groups

data
any[]
meta
object
cursor
object