v1

latestOpenAPI 3.0.2Apache 2.02026-07-136548173.9 KB

Groups

List groups

Returns a list of all groups. This list is paged.

get/groups

Query parameters

limitinteger

The number of groups to return. Defaults to 20.

offsetinteger

The number of groups to skip before starting the result set. Defaults to 0.

order'asc' | 'desc'

Sort order, ascending (asc) or descending (desc).

orderby'name' | 'createdOn'

The field to sort by. Can be one of:

name
createdOn

Response

On a successful response, returns a bounded set of groups.

countinteger required

The total number of groups that matched the query that produced the result set (may be more than the number of groups in the result set).

Example response

{
  "groups": [
    {
      "id": "My-Group",
      "name": "Group Name",
      "description": "Description of the group",
      "createdBy": "user1",
      "createdOn": "2019-03-22T12:51:19Z",
      "modifiedBy": "user1",
      "modifiedOn": "2019-03-22T12:51:19Z"
    }
  ]
}