GET [/instances/$INSTANCES]/private/groups

This is used to return all the groups that are present in our backend.

Required permission: groups-read

Request:

Query Parameters:

• limit – Optional. At most return the given number of results. Negative for descending by serial, positive for ascending by serial. Defaults to -20.

• offset – Optional. Starting serial for pagination.

Response:

200 OK:

The backend has successfully returned all the groups. Returns a GroupsSummaryResponse.

404 Not found:

The backend has does not know about the instance.

Details:

interface GroupsSummaryResponse {

  // Return groups that are present in our backend.
  groups: GroupEntry[];

}

The GroupEntry object describes a group. It has the following structure:

interface GroupEntry {

  // Group identifier
  group_serial: Integer;

  // Unique name for the group (unique per instance).
  group_name: string;

  // Description for the group.
  description: string;

}