---
title: "Get the mailbox access mode"
method: GET
path: "/access-mode"
tags: ["Roles and members"]
---

# Get the mailbox access mode

`GET /access-mode`

## Request

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

Whole-org or delegated mailbox access. Holders of roles:assign also get the preview of a switch (every item that needs a decision, each with the decision_options it takes, worded for what the switch does) and the decisions made, plus notices: member and group domain entries that delegated mode keeps off personal mailboxes, each with how many it leaves out. Notices are informational, never decided, and never hold the switch (notices_truncated past 500, notices_unavailable when they could not be read). Any person; API keys are refused.

## Response `200`

Get the mailbox access mode

- object
  - `success` true, required
  - `data` GetAccessModeResult, required
    - `mode` 'whole_org' | 'delegated', required
    - `version` number, required
    - `changed_at` string, nullable, required
    - `preview` object[]
    - `notices` object[]
    - `notices_truncated` boolean
    - `notices_unavailable` boolean
    - `decisions` object
    - `gate` object

## 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)