ATatlassian
Group

Search groups by partial query

Get search results of groups by partial query provided.

get/wiki/rest/api/group/picker

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/wiki/rest/api/group/picker
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token scopes: read:confluence-groups

Query parameters

querystring required

the search term used to query results.

startinteger

The starting index of the returned groups.

limitinteger

The maximum number of groups to return per page. Note, this is restricted to a maximum limit of 200 groups.

shouldReturnTotalSizeboolean

Whether to include total size parameter in the results. Note, fetching total size property is an expensive operation; use it if your use case needs this value.

Response

Returns a full JSON representation of group collection.

startinteger required
limitinteger required
sizeinteger required
totalSizeinteger

This property will return total count of the objects before pagination is applied. This value is returned if shouldReturnTotalSize is set to true.

_linksGenericLinks required

Changes

No recorded changes to this operation across all 2 revisions of this API.