Sign in

v1

latestOpenAPI 3.1.02026-08-04751,1671.3 MB
User Groups

List User Groups

Get a list of user groups

get/api/v1/user-groups

Query parameters

pageinteger

The page number to fetch.

The page number to fetch.

sizeinteger

The number of items per page.

The number of items per page.

skip_countboolean

Whether to skip counting the total number of items.

Whether to skip counting the total number of items.

statesUserGroupState[]
user_group_idsstring[]
user_idsstring[]
modified_bystring[]
namestring
searchstring
exclude_user_group_idsstring[]

The group IDs to exclude.

The group IDs to exclude.

sort_byUserGroupSortableFields[]

Response

Successful Response

totalinteger required
pageinteger required
sizeinteger required

Example response

{
  "user_groups": [
    {
      "modified_by": {
        "name": "John Doe"
      },
      "proposed_change": {
        "created_by": {
          "name": "John Doe"
        },
        "added_users": [
          {
            "name": "John Doe"
          }
        ],
        "removed_users": [
          {
            "name": "John Doe"
          }
        ]
      }
    }
  ]
}