---
title: "Search groups by partial query"
method: GET
path: "/wiki/rest/api/group/picker"
tags: ["Group"]
---

# Search groups by partial query

`GET /wiki/rest/api/group/picker`

Get search results of groups by partial query provided.

## Query parameters

- `query` string, required
- `start` integer
- `limit` integer
- `shouldReturnTotalSize` boolean

## Response `200`

Returns a full JSON representation of group collection.

- GroupArrayWithLinks — Same as GroupArray but with `_links` property.
  - `results` Group[], required
    - `type` 'group', required
    - `name` string, required
    - `id` string, required
    - `usageType` 'USERBASE_GROUP' | 'TEAM_COLLABORATION' — This property represents how this collection of users is used: - `USERBASE_GROUP`: This value indicates that the collection of users is used as a group. - `TEAM_COLLABORATION`: This value indicates that the collection of users is used as a team.
    - `managedBy` 'ADMINS' | 'EXTERNAL' | 'TEAM_MEMBERS' | 'OPEN' — This property represents how this collection of users is managed: - `ADMINS`: This value indicates that the collection of users is managed by org, site or product admins. - `EXTERNAL`: This value indicates that the collection of users is managed externally (through SCIM, HRIS, etc.). - `TEAM_MEMBERS`: This value indicates that the collection of users is managed by its members. - `OPEN`: This value indicates that the collection of users is not actively managed by any users.
    - `_links` GenericLinks
  - `start` integer, required
  - `limit` integer, required
  - `size` integer, required
  - `totalSize` integer — This property will return total count of the objects before pagination is applied. This value is returned if `shouldReturnTotalSize` is set to `true`.
  - `_links` GenericLinks, required

## Other responses

- `403` — Returned if the calling user does not have permission to view groups.

---

[API](https://skmtc.net/atlassian/apis/the-confluence-cloud-rest-api.md) · [All operations](https://skmtc.net/atlassian/apis/the-confluence-cloud-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/atlassian/the-confluence-cloud-rest-api/revisions/70088490f406/schema)