DOCUMENTATIONv2

GET

Notifications

List unread account signals

/api/v2/notifications/unread

AUTHENTICATIONBearer token · profile:readAUTHORITATIVE OWNERnotificationsCONTRACT AUTHORITYGenerated Rust OpenAPISTATUSSource ready · production listed

PURPOSE + BUSINESS CONTEXT

List only unread operational signals for the authenticated profile and workspace, with the same bounded cursor and no-authority guarantees as the complete inbox.

WHEN THIS CALL IS USEFUL

Use for badges, attention queues, and agents that process only unacknowledged account signals without downloading read or archived history.

OUTCOME · Discover

What changes

Read-only projection; it grants no mutation, settlement, traffic, or authority change.

WHY IT MATTERS

Gives people and agents a contract-backed way to discover unread account signals.
Provides a bounded attention queue with stable references and unread state while preserving the owning domain as the authority for any consequential action.

ISOLATION + AUTHORITY

Profile, workspace, notification, delivery channel, read or archive status, referenced resource, and owning-domain lifecycle remain distinct. Reading, marking, or archiving a signal changes only inbox presentation state and never authorizes, executes, reverses, or resolves the referenced business action.

BEFORE YOU CALL

Authenticate at the documented boundary: bearer+scope.
Use the live OpenAPI schema as the authority for the exact request shape and response model.
Resolve the authenticated profile and workspace plus the canonical resource reference and owning domain for any signal that may require action.

WHAT TO DO NEXT

Use the signal's canonical resource reference to open and re-read the authoritative domain record before offering a response.
Advance the cursor or refresh the unread aggregate without treating inbox presence or absence as resolution of the underlying event.

AGENT GUIDANCE

Use unread account signals only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
Use the live OpenAPI schema as the authority for the exact request shape and response model.
Distinguish signal delivery, unread state, acknowledgement, archival, referenced-resource state, and resolution in the authoritative domain workflow.
Use response links and canonical identifiers instead of constructing internal service URLs or scraping the website.

MACHINE CONTRACT

The exact deployed parameters, schemas, responses, security requirements, and Hybrid-Chain agent metadata are authoritative at this operation's production OpenAPI JSON Pointer. The readable tables below add integration guidance; the deployed OpenAPI controls if guidance and the machine contract ever differ.

Open the authoritative production contract ↗

EXTENDED INTEGRATION GUIDANCE

Readable request and response reference

Examples illustrate integration intent; the referenced OpenAPI operation and component schemas define the executable shape.

PARAMETERS

Headers, path, query, and body

NAMELOCATIONPRESENCETYPE / RULES / PURPOSE

AuthorizationheaderRequired

Bearer tokenCredential containing the profile:read scope.EXAMPLEBearer hc_live_…

cursorqueryOptional

decimal offset · 0–1000000Cursor returned by the preceding unread page; defaults to 0.EXAMPLE0

limitqueryOptional

integer · 1–100Maximum newest unread signals to return; defaults to 50.EXAMPLE50

includeArchivedqueryOptional

booleanAccepted for contract consistency but unread records are never archived.EXAMPLEfalse

RESPONSES

Status and payload examples

200Unread-only owner-scoped account-signal page.Read completed · JSON RESPONSE+

{
  "items": [
    {
      "notificationUuid": "notice-workspace-invitation-20260901",
      "title": "Workspace invitation",
      "message": "An invitation is ready for review.",
      "type": "WORKSPACE_INVITATION",
      "source": "WORKSPACES",
      "status": "UNREAD",
      "reference": "invitation-01J…",
      "href": "/account/workspaces",
      "createdAt": "2026-09-01T18:45:00.000000Z",
      "updatedAt": "2026-09-01T18:45:00.000000Z"
    }
  ],
  "unreadCount": 1,
  "nextCursor": null,
  "limit": 50
}

INTEGRATION DECISION

CALLER ACTION: Accept the returned representation or receipt, then use the signal's canonical resource reference to open and re-read the authoritative domain record before offering a response.
RETRY SAFETY: For another page, send the returned opaque cursor unchanged with the same filters. Restart without a cursor when a new snapshot is required.
STATE RECONCILIATION: Use returned identifiers and versions as the comparison point for later reads. Refresh the specific profile or account projection and compare tenant, profile, lifecycle, and version identifiers before retrying.

400The cursor or limit is invalid.Request must change · JSON RESPONSE+

{
  "code": "invalid_notification_query",
  "message": "The cursor or limit is invalid."
}

INTEGRATION DECISIONinvalid_notification_query

CALLER ACTION: Rebuild the request from the live OpenAPI operation and correct the rejected method, media type, header, parameter, or body field.
RETRY SAFETY: Do not retry the same invalid request. A corrected read may be sent as a new attempt.
STATE RECONCILIATION: Compare the submitted values with the documented constraints before another call. Refresh the specific profile or account projection and compare tenant, profile, lifecycle, and version identifiers before retrying.
ESCALATE WHEN: Escalate when a fresh session resolves to an unexpected tenant or profile, or when an account lifecycle receipt cannot be found after reconciliation.

401The bearer credential is missing or invalid.Authentication required · JSON RESPONSE+

{
  "code": "invalid_credentials",
  "message": "The bearer credential is missing or invalid."
}

INTEGRATION DECISIONinvalid_credentials

CALLER ACTION: Discard the rejected credential, complete the documented authentication or reassertion flow, and rebuild any request signature with fresh timestamps and nonces.
RETRY SAFETY: Retry only with a newly valid credential and fresh replay-protection values. Do not replay an expired signature.
STATE RECONCILIATION: Authentication failed before an authoritative read was returned for the authenticated profile, tenant brand, referral, funding, and account-lifecycle projections.
ESCALATE WHEN: Escalate when a fresh session resolves to an unexpected tenant or profile, or when an account lifecycle receipt cannot be found after reconciliation.

403The credential lacks profile:read or the owner boundary is unavailable.Authority or policy denied · JSON RESPONSE+

{
  "code": "insufficient_scope",
  "message": "The credential lacks profile:read or the owner boundary is unavailable."
}

INTEGRATION DECISIONinsufficient_scope

CALLER ACTION: Verify the exact scope, tenant or workspace membership, owner boundary, step-up purpose, feature policy, and resource eligibility. Never broaden authority automatically.
RETRY SAFETY: Do not retry until the missing authority or policy condition has been deliberately resolved with least privilege.
STATE RECONCILIATION: Confirm the caller and resource resolve to the same authority boundary for the authenticated profile, tenant brand, referral, funding, and account-lifecycle projections.
ESCALATE WHEN: Escalate when a fresh session resolves to an unexpected tenant or profile, or when an account lifecycle receipt cannot be found after reconciliation.

503The authoritative owner-scoped inbox is unavailable.Dependency unavailable or outcome uncertain · JSON RESPONSE+

{
  "code": "notifications_unavailable",
  "message": "The authoritative owner-scoped inbox is unavailable."
}

INTEGRATION DECISIONnotifications_unavailable

CALLER ACTION: Treat the failure as transient and preserve the last known good representation without presenting it as fresh.
RETRY SAFETY: Retry with bounded exponential backoff and jitter; stop after the integration's failure budget is exhausted.
STATE RECONCILIATION: Refresh the specific profile or account projection and compare tenant, profile, lifecycle, and version identifiers before retrying.
ESCALATE WHEN: Escalate when a fresh session resolves to an unexpected tenant or profile, or when an account lifecycle receipt cannot be found after reconciliation.

OPERATIONAL NOTES

Security and lifecycle guarantees

Use for attention badges and queues that do not need read or archived history. The route always applies UNREAD; use the complete inbox for any other lifecycle.
Processing the referenced workflow and acknowledging its signal are separate. Complete or reconcile the owning workflow before marking READ when that distinction matters.
The same owner, no-store, routing-metadata, and no-domain-authority guarantees as the complete inbox apply.

UPGRADING FROM V1

Legacy calls replaced by this operation

If you maintain an older integration, use this map to find the V2 replacement. Do not translate the old request field-for-field: rebuild it from the V2 parameters and schemas above because identity, authorization, replay protection, and response semantics may have changed.

GET/api/v1/notifications/unreadNOTIFICATIONS: Get Unread Notifications

DOCUMENTATION STATUS

This route is implemented in canonical gateway source and appears in the production OpenAPI snapshot observed 2026-09-11T06:35:11.572Z. Authentication, tenant, feature, venue, and market policy still apply.

Verify the exact production OpenAPI operation ↗Return to the V2 directory ↗