---
title: "Get Mailzero assistant settings"
method: GET
path: "/api/assistant/settings"
tags: ["Mailzero Assistant"]
---

# Get Mailzero assistant settings

`GET /api/assistant/settings`

## Request

- Base URL: `https://domani.run`
- URL: `https://domani.run/api/assistant/settings`
- Auth: HTTP bearer

Returns the assistant opt-in state, shadow/pause flags, consent version, privacy route, mailbox scope, and every mailbox you own. Requires the assistant:read scope.

## Response `200`

Assistant opt-in, privacy route, mailbox scope, and available mailboxes

- AssistantSettings
  - `enabled` boolean
  - `shadow_enabled` boolean
  - `paused` boolean
  - `mailbox_ids` string[]
  - `agent_mailbox_ids` string[]: Mailboxes operated by your agents. Their items appear in the agents section of Today instead of Needs you.
  - `agents` object[]: Your agent identities, for delegation.
    - `slug` string
    - `name` string
    - `emoji` string, nullable
  - `search_opt_out_mailbox_ids` string[]: Mailboxes whose mail is searched by words only: their messages are never sent to the embedding model.
  - `brief_opt_out_mailbox_ids` string[]: Mailboxes whose briefs stay deterministic: no evidence excerpt is sent to the model for the summary and next move (the analysis of arriving mail is unchanged)
  - `history_window_days` integer
  - `privacy_route` 'private_cloud'
  - `attachment_vision` boolean
  - `community_signals` boolean: Your phishing reports count toward the community fingerprints (a domain, the shape of a subject, never a text or an address) and the community's counts reach your trust signals. On by default; off keeps both local.
  - `pipeline_version` string
  - `consent` object
    - `required_version` string
    - `accepted_version` string, nullable
    - `accepted_at` string, nullable
  - `mailboxes` object[]
    - `id` string
    - `slug` string
    - `domain` string
    - `name` string, nullable
    - `kind` string
    - `address` string

## Other responses

- `401`: Missing or invalid API key
- `429`: Rate limit exceeded - wait and retry

---

[API](https://skmtc.dev/domani/apis/domani-run-api.md) · [All operations](https://skmtc.dev/domani/apis/domani-run-api/llms.txt) · [OpenAPI document](https://skmtc.dev/domani/apis/domani-run-api/revisions/7679f8159533?raw)