Get a collection of groups.

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

Only return groups with this id or partial match using wildcards (*, ?).

  • matches zero or more characters.
  • ? matches exactly one character.

For example, bo* will match any word starting with bo, such as bo, bom, body, and so on. On the other hand, bo? will only match three-letter words starting with bo, such as bo, bom, and so on.

string

Only return groups with this name or partial match using wildcards (*, ?).

  • matches zero or more characters.
  • ? matches exactly one character.

For example, bo* will match any word starting with bo, such as bo, bom, body, and so on. On the other hand, bo? will only match three-letter words starting with bo, such as bo, bom, and so on.

string

filter response by this organisation id

string

filter response by a comma separated list of group ids

number

Maximum number of streams to return

number

Skip this many results.

boolean

Return full details of groups

boolean

Return full details of groups and linked objects

string

The field in the usermetadata you'd like to filter by. Use dot notation to access subfields, match literal dots with "." and literal dollar signs with "$".

string

Filter response by a comma separated list of values that match the object's usermetadatafield

Responses

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