List one row per Group, including empty Groups, on Admin → People.

GET

/api/v1/admin/groups

const url = 'https://example.com/api/v1/admin/groups';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/admin/groups \
  --header 'Authorization: Bearer <token>'

Route: /api/v1/admin/groups. Inputs: . Safe reads can use bounded retries.

Authorizations

installationBearer
browserSession

Responses

200

application/json

Array<object>

Membership is returned only under the Instance admin guard (#1028).

object

required

string format: uuid

member_ids

required

Array<string>

name

required

string

Example^generated

[
  {
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "member_ids": [
      "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
    ],
    "name": "example"
  }
]

List one row per Group, including empty Groups, on Admin → People.

Authorizations

Responses

200

Examplegenerated

403

Example^generated