Book a demo

get_notification_policy

Read an org's notification settings

read collection tenant-private since 2026-10-01

Lists the org's six notice kinds in order: the audit log digest, admin activity alerts, staff access requests, break-glass access, deletion notices and announcements. Each carries its fixed recipients, which nothing removes (org_admins: every admin of the org; deleted_user: the user a user deletion is about), the members, outside email addresses and Slack channels the org also requires, and for the digest its cadence. A Slack channel is its name and id, never its webhook URL.

Contract

shape
collection
authority
read
evidence
none
subscription
false
permission
any one of: org.admin (carried by the caller's role template in the org `org_id`); a deactivated caller is refused first
idempotency
safe
emits
none
MCP tool
get_notification_policy
REST
POST https://api.containertradehq.com/v1/cap/get_notification_policy

Idempotency: a read: calling again changes nothing

Inputs

nametyperequiredvalidation
org_idorg_idrequiredtradehq-org-id; 1 to 20 characters
The org whose notification settings to read.

Paginated: next next_after · page_max 6 · walk_max 6 · ceiling declared

Response

  • items · object[]
  • next_after · stringnull · Pass as `after` for the next page; null on the last one.
Full JSON Schema 
{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "enum": [
              "audit_digest",
              "admin_alerts",
              "access_request",
              "break_glass",
              "deletion",
              "announcement"
            ],
            "description": "The notice kind.",
            "x-data-class": "operational"
          },
          "title": {
            "type": "string",
            "description": "Its name, as the page shows it.",
            "x-data-class": "operational"
          },
          "sent": {
            "type": "string",
            "description": "When it is sent.",
            "x-data-class": "operational"
          },
          "fixed": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The recipients fixed in code, which nothing removes: org_admins (every admin of the org) and, for a deletion, deleted_user (the user a user deletion is about).",
            "x-data-class": "operational"
          },
          "recipients": {
            "anyOf": [
              {
                "type": "object"
              },
              {
                "const": "•••",
                "description": "Masked by the caller's data policy."
              },
              {
                "type": "null",
                "description": "Denied by the caller's data policy."
              }
            ],
            "description": "Who the org also requires: {members: [{user_id, name}], outside: [email], slack: [{id, channel_name}]}. A Slack channel is its name and id, never its webhook URL.",
            "x-data-class": "personal"
          },
          "cadence": {
            "type": [
              "string",
              "null"
            ],
            "enum": [
              "hourly",
              "daily",
              null
            ],
            "description": "The audit digest's cadence, hourly or daily; null for every other kind.",
            "x-data-class": "operational"
          }
        },
        "required": [
          "kind",
          "title",
          "sent",
          "fixed",
          "recipients",
          "cadence"
        ],
        "additionalProperties": false
      },
      "maxItems": 6
    },
    "next_after": {
      "type": [
        "string",
        "null"
      ],
      "description": "Pass as `after` for the next page; null on the last one."
    }
  },
  "required": [
    "items",
    "next_after"
  ],
  "additionalProperties": false
}

Refusals

The platform refusals apply to every call: version, authentication, authority, validation and rate limits, each in the same envelope.

Surfaces

DesktopF
MobileF
APIF
MCPF
VoiceD4
PushN
OneBoxN
OutboundN
  • Voice: degraded: visualization
  • Push: emits nothing
  • OneBox: no document originates a notification settings
  • Outbound: crosses to no counterparty

Events

None emitted.

Related

None.