groups

Postman Collection

OpenAPI

Operations

GET/api/2/groups/picker

GET

Get groups matching a query

Returns groups with substrings matching a given query

Forge and OAuth2 apps cannot access this REST resource.

Request

Query parameters

maxResults

string

query

string

exclude

string

userName

string

Responses

Returns a collection of matching groups

application/json

GroupSuggestionsBean

GET/api/2/groups/picker

curl

Node.js

Java

Python

PHP

curl --request GET \
  --url 'http://{baseurl}/rest/api/2/groups/picker' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

200Response

{
  "groups": [
    {
      "html": "<b>j</b>dog-developers",
      "labels": [
        {
          "text": "jdog-developers",
          "title": "Developers",
          "type": "SINGLE"
        }
      ],
      "name": "jdog-developers"
    }
  ],
  "header": "Showing 20 of 25 matching groups",
  "total": 25
}