Book a demo

list_my_notifications

List my notifications

read collection tenant-private since 2026-10-01

Lists the notice kinds the caller's role can already see in the org, in the page's order, each with its state: fixed (sent to them by code, as an org admin), required (the org's notification settings names them), opted_in (they added it themselves), on (Report updates, sent by default until they turn it off) or available (they may add it with set_my_notification). Carries the audit digest's and Report updates' cadence and the sign-in address notices are emailed to.

Contract

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

Idempotency: a read: calling again changes nothing

Inputs

nametyperequiredvalidation
org_idorg_idrequiredtradehq-org-id; 1 to 20 characters
The org the caller is a member of.

Paginated: next next_after · page_max 7 · walk_max 7 · 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",
              "report_updates"
            ],
            "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"
          },
          "state": {
            "type": "string",
            "enum": [
              "fixed",
              "required",
              "opted_in",
              "on",
              "available"
            ],
            "description": "fixed: sent to the caller by code (an org admin's notices). required: the org's notification settings names them. opted_in: they added it themselves. on: sent to them by default until they turn it off (Report updates). available: they may add it, or turn it back on.",
            "x-data-class": "operational"
          },
          "cadence": {
            "type": [
              "string",
              "null"
            ],
            "enum": [
              "hourly",
              "daily",
              "immediately",
              "weekly",
              null
            ],
            "description": "How often the caller receives it: the audit digest hourly or daily (hourly until they choose); Report updates immediately, daily or weekly (immediately until they choose); null for every other kind.",
            "x-data-class": "operational"
          },
          "email": {
            "anyOf": [
              {
                "type": [
                  "string",
                  "null"
                ]
              },
              {
                "const": "•••",
                "description": "Masked by the caller's data policy."
              },
              {
                "type": "null",
                "description": "Denied by the caller's data policy."
              }
            ],
            "description": "The sign-in address a notice is emailed to.",
            "x-data-class": "personal"
          }
        },
        "required": [
          "kind",
          "title",
          "sent",
          "state",
          "cadence",
          "email"
        ],
        "additionalProperties": false
      },
      "maxItems": 7
    },
    "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 person's notices
  • Outbound: crosses to no counterparty

Events

None emitted.

Related

None.