These docs are for v0.0.1. Click to read the latest docs for v1.0.63.

List Groups

This API requires the Account Administrator role.

Lists the groups for an account.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 6 and 6
^[a-zA-Z]{6}$

The unique 6 character internal id that represents the customer account.

Query Params
int32
≥ 1
Defaults to 1

The page number of the records to retrieve. Default value is 1

int32
5 to 50
Defaults to 5

The max number of records to retrieve per page. Default value is 5,max value is 50.

string
length ≤ 255

Specifies details of a row filter.

The supported field that you can filter on are:

  • name
  • organizationNodeId
  • membershipType

The allowed format:

  • Begins with the column name to be filtered, followed by a colon, (This will be used as Contains operator.) then:
    • Either an exact string to match, or
    • A string expression including the * wildcard character.
      • :{PREFIX}* will be used to find out word start with.
      • :*{POSTFIX} will be used to find out word end with
      • : will be used to match exact word
  • Begin with column name to be filtered, followed by a = operator. (this will be used to match exact string)
string
length ≤ 255

Field name on which sorting needs to be performed.

The possible fields you ordered on are:

  • name

Field Names are case-sensitive (should be written as it is in description).

The default sorting order is ascending.

To specify descending order, a suffix " desc" should be added. For example, "name" for ascending or "name desc" for descending".

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Choose an example:
application/json
application/problem+json