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

# List mailbox access

`GET /mailbox-access`

## Request

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

Every access entry in the organization: who (a member, group, agent or address) may read, draft or send for each mailbox or domain, and at what depth. Needs members:read: a person, or an org-wide API key whose person holds it.

## Response `200`

List mailbox access

- object
  - `success` true, required
  - `data` ListMailboxAccessResult, required
    - `entries` object[], required
      - `id` string, required
      - `mailbox_address` string, nullable, required
      - `mailbox_domain` string, nullable, required
      - `mailbox_kind` 'personal' | 'shared' | 'agent' | 'app', nullable, required
      - `principal_kind` 'member' | 'group' | 'agent' | 'app' | 'address', required
      - `principal_user_id` string, nullable, required
      - `principal_group_id` string, nullable, required
      - `principal_agent_connection_id` string, nullable, required
      - `principal_address` string, nullable, required
      - `actions` string[], required
      - `depth` 'metadata' | 'content' | 'raw', required
      - `created_at` string, required
      - `updated_at` 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)