GET /wiki/rest/api/group

Returns all user groups. The returned groups are ordered alphabetically in ascending order by group name.

Permissions required: Permission to access the Confluence site ('Can use' global permission).

Servers

Query parameters

Name Type Required Description
limit Integer No

The maximum number of groups to return per page. Note, this may be restricted by fixed system limits.

Default value: 200

start Integer No

The starting index of the returned groups.

Default value: 0

accessType String No

The group permission level for which to filter results.

Possible values:

  • "site-admin"
  • "admin"
  • "user"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.