Group list

Request description

Endpoint: /users/groups/:limit/:lastGroupId
Method: GET

The following parameters can be passed through the URL:

• limit: specifies the maximum number of users to return in the query
  
• lastGroupId: specifies the identifier of the last groupId returned. This parameter is used if pagination is to be performed.
  

Header

{
  "Content-Type": "application/json",
  "Authorization": "Bearer <accessToken>"
}

Note: the <accessToken> is obtained as a result of the authentication

Responses

Correct response

type ListGroupsResponseType = {
  groups: IGroup[] // List of groups related to the query
}

interface IGroup = {
   id: string, // Unique group identifier
   name: string // Group name
}

Wrong responses

{
  // empty body
}

Description: this error occurs when endpoint authorizers fail to validate the token sent in the request header.

type ListGroupsResponseType = {
  errorType: LIST_GROUPS_ERROR_TYPE,
    errorMessage?: string
}

enum LIST_GROUPS_ERROR_TYPE {
    INVALID_LIMIT_VALUE = 'invalidLimitValue'
}