Groups

Postman Collection

OpenAPI

Orgs Groups APIs

Operations

POST/v1/orgs/{orgId}/groups/search

POST

Search for groups within an organizationExperimental

The API is available for customers using the new user management experience only. How the new user management experience works

Returns a list of groups within an organization, offering search functionality through multiple parameters for more precise results.

Request

Path parameters

orgId

string

Required

Request bodyapplication/json

groupIds

array<string>

groupNames

GroupNames

cursor

string

limit

integer

expand

array<string>

Responses

Organization found. Response contains group search results

application/json

GroupsSearchPage

POST/v1/orgs/{orgId}/groups/search

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url 'https://api.atlassian.com/admin/v1/orgs/{orgId}/groups/search' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "limit": 20
}'

200Response

{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>"
    }
  ],
  "links": {
    "next": "<string>",
    "self": "<string>"
  }
}