---
title: "List groups"
method: GET
path: "/groups"
tags: ["Mailbox access"]
---

# List groups

`GET /groups`

## Request

- Base URL: `https://api.primitive.dev/v1`
- URL: `https://api.primitive.dev/v1/groups`
- Auth: HTTP bearer

Every group, with its members and role. A group can be named in a mailbox access entry. Needs members:read: a person, or an org-wide API key whose person holds it.

## Response `200`

List groups

- object
  - `success` true, required
  - `data` ListGroupsResult, required
    - `groups` object[], required
      - `id` string, required
      - `name` string, required
      - `description` string, nullable, required
      - `role_id` string, nullable, required
      - `members` string[], required

## Other responses

- `401`: Invalid or missing API key
- `403`: Authenticated caller lacks permission for the operation
- `404`: feature_disabled: the feature is not enabled for the organization; or not_found: the item the path names does not exist.
- `409`: conflict: the item changed while you edited it, or a member was removed and added back. Look again, then retry.
- `429`: Rate limit exceeded. The `ratelimit-*` headers describe the limiter that rejected this request, with its own limit and window, not the API budget that successful responses report. A limiter that reports only a wait sends `Retry-After` alone.

---

[API](https://skmtc.dev/primitive/apis/primitive-api.md) - [All operations](https://skmtc.dev/primitive/apis/primitive-api/llms.txt) - [OpenAPI document](https://skmtc.dev/primitive/apis/primitive-api/revisions/bce409c97acb?raw)