Notifications

Generated notifications operations.

GET/v1/notificationsRead or update the selected projectionread

Audience: Clients · Native API
Authorization: API key or personal access token with the read scope, or a signed-in session
OpenAPI operation ID: get_notifications

Parameters

Name	In	Type	Description
`cursor`	query	`string`
`limit`	query	`integer \| ""`1–40

Responses

200Successapplication/json

Example

{
  "data": {
    "items": [
      {
        "code": "string",
        "createdAt": "2026-10-18T19:30:00Z",
        "id": "id_8h2k4q",
        "message": "string",
        "readAt": "2026-10-18T19:30:00Z",
        "targetId": "id_8h2k4q"
      }
    ],
    "nextCursor": "eyJvIjoyMH0",
    "unread": 0
  },
  "scope": {
    "serverId": "id_8h2k4q",
    "viewerFence": "string"
  }
}

Schema

dataobjectrequired
- itemsarray of objectrequired
  - codestringrequired
  - createdAtstringrequired
    RFC 3339 UTC instant; empty when absent.
  - idstringrequired
  - messagestringrequired
  - readAtstring | any | nullrequired
  - targetIdstring
- nextCursorstringrequired
- unreadintegerrequired
scopeobjectrequired
- serverIdstringrequired
- viewerFencestringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/notifications" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

POST/v1/notifications/{id}/readRun notifications readplayback

Audience: Clients · Native API
Authorization: API key or personal access token with the playback scope, or a signed-in session
OpenAPI operation ID: post_notifications_id_read

Parameters

Name	In	Type	Description
`id`required	path	`string`

Responses

200Successapplication/json

Example

{
  "data": {
    "key": true
  },
  "scope": {
    "serverId": "id_8h2k4q",
    "viewerFence": "string"
  }
}

Schema

dataobjectrequired
scopeobjectrequired
- serverIdstringrequired
- viewerFencestringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/notifications/{id}/read" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/v1/notifications/capabilitiesRead notifications capabilitiesread

Audience: Clients · Native API
Authorization: API key or personal access token with the read scope, or a signed-in session
OpenAPI operation ID: get_notifications_capabilities

Responses

200Successapplication/json

Example

{
  "data": {
    "audiences": [
      "string"
    ],
    "commands": [
      "string"
    ],
    "heartbeatMs": 1800000,
    "maxLimit": 0,
    "maxWaitMs": 1800000,
    "severities": [
      "string"
    ],
    "sources": [
      "string"
    ],
    "states": [
      "string"
    ],
    "views": [
      "string"
    ]
  },
  "scope": {
    "serverId": "id_8h2k4q",
    "viewerFence": "string"
  }
}

Schema

dataobjectrequired
- audiencesarray of stringrequired
- commandsarray of stringrequired
- heartbeatMsintegerrequired
- maxLimitintegerrequired
- maxWaitMsintegerrequired
- severitiesarray of stringrequired
- sourcesarray of stringrequired
- statesarray of stringrequired
- viewsarray of stringrequired
scopeobjectrequired
- serverIdstringrequired
- viewerFencestringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/notifications/capabilities" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/v1/notifications/inboxRead or update the selected projectionread

Audience: Clients · Native API
Authorization: API key or personal access token with the read scope, or a signed-in session
OpenAPI operation ID: get_notifications_inbox

Parameters

Name	In	Type
`audience`	query	`string`
`state`	query	`string`
`cursor`	query	`string`
`limit`	query	`integer \| ""`1–100

Responses

200Successapplication/json

Example

{
  "data": {
    "audience": "string",
    "audiences": [
      "string"
    ],
    "counts": {
      "archived": 0,
      "read": 0,
      "total": 0,
      "unread": 0
    },
    "items": [
      {
        "actions": [
          {}
        ],
        "archived": true,
        "archivedAt": "2026-10-18T19:30:00Z",
        "arguments": {
          "key": "string"
        },
        "audience": "string",
        "body": "string",
        "category": "string",
        "createdAt": "2026-10-18T19:30:00Z",
        "cursor": "eyJvIjoyMH0",
        "dedupeKey": "string",
        "expiresAt": "2026-10-18T19:30:00Z",
        "id": "id_8h2k4q",
        "read": true,
        "readAt": "2026-10-18T19:30:00Z",
        "revision": 0,
        "severity": "string",
        "source": "string",
        "title": "Fargo",
        "updatedAt": "2026-10-18T19:30:00Z"
      }
    ],
    "nextCursor": "eyJvIjoyMH0",
    "observedAt": "2026-10-18T19:30:00Z",
    "retentionDays": 0,
    "revision": 0,
    "state": "string"
  },
  "scope": {
    "serverId": "id_8h2k4q",
    "viewerFence": "string"
  }
}

Schema

dataobjectrequired
- audiencestringrequired
- audiencesarray of stringrequired
- countsobjectrequired
  - archivedintegerrequired
  - readintegerrequired
  - totalintegerrequired
  - unreadintegerrequired
- itemsarray of objectrequired
  - actionsarray of objectrequired
    argumentsobject
    commandstring
    kindstringrequired
    labelstringrequired
    targetobject
    entityIdstring
    libraryIdstring
    viewstringrequired
  - archivedbooleanrequired
  - archivedAtstring | any | nullrequired
  - argumentsobjectrequired
  - audiencestringrequired
  - bodystringrequired
  - categorystringrequired
  - createdAtstringrequired
    RFC 3339 UTC instant; empty when absent.
  - cursorstringrequired
  - dedupeKeystringrequired
  - expiresAtstringrequired
    RFC 3339 UTC instant; empty when absent.
  - idstringrequired
  - readbooleanrequired
  - readAtstring | any | nullrequired
  - revisionintegerrequired
  - severitystringrequired
  - sourcestringrequired
  - titlestringrequired
  - updatedAtstringrequired
    RFC 3339 UTC instant; empty when absent.
- nextCursorstringrequired
- observedAtstringrequired
  RFC 3339 UTC instant; empty when absent.
- retentionDaysintegerrequired
- revisionintegerrequired
- statestringrequired
scopeobjectrequired
- serverIdstringrequired
- viewerFencestringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/notifications/inbox" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

POST/v1/notifications/inbox/actionsRun notifications inbox actionsplayback

Audience: Clients · Native API
Authorization: API key or personal access token with the playback scope, or a signed-in session
OpenAPI operation ID: post_notifications_inbox_actions
Max body: 64 KiB

Request body application/json · required

Example

{
  "audience": "string",
  "expectedRevision": 0,
  "operationId": "id_8h2k4q",
  "operations": [
    {
      "action": "string",
      "ids": [
        "string"
      ]
    }
  ]
}

Schema

audiencestringrequired
expectedRevisionintegerrequired
operationIdstringrequired
operationsarray of objectrequired
- actionstringrequired
- idsarray of string

Responses

200Successapplication/json

Example

{
  "data": {
    "applied": 0,
    "audience": "string",
    "counts": {
      "archived": 0,
      "read": 0,
      "total": 0,
      "unread": 0
    },
    "receipts": [
      {
        "action": "string",
        "id": "id_8h2k4q",
        "outcome": "string"
      }
    ],
    "revision": 0
  },
  "scope": {
    "serverId": "id_8h2k4q",
    "viewerFence": "string"
  }
}

Schema

dataobjectrequired
- appliedintegerrequired
- audiencestringrequired
- countsobjectrequired
  - archivedintegerrequired
  - readintegerrequired
  - totalintegerrequired
  - unreadintegerrequired
- receiptsarray of objectrequired
  - actionstringrequired
  - idstring
  - outcomestringrequired
- revisionintegerrequired
scopeobjectrequired
- serverIdstringrequired
- viewerFencestringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/notifications/inbox/actions" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"audience":"string","expectedRevision":0,"operationId":"id_8h2k4q","operations":[{"action":"string","ids":["string"]}]}'

GET/v1/notifications/unread-countRead or update the selected projectionread

Audience: Clients · Native API
Authorization: API key or personal access token with the read scope, or a signed-in session
OpenAPI operation ID: get_notifications_unread_count

Parameters

Name	In	Type	Description
`audience`	query	`string`

Responses

200Successapplication/json

Example

{
  "data": {
    "audience": "string",
    "counts": {
      "archived": 0,
      "read": 0,
      "total": 0,
      "unread": 0
    },
    "observedAt": "2026-10-18T19:30:00Z",
    "revision": 0
  },
  "scope": {
    "serverId": "id_8h2k4q",
    "viewerFence": "string"
  }
}

Schema

dataobjectrequired
- audiencestringrequired
- countsobjectrequired
  - archivedintegerrequired
  - readintegerrequired
  - totalintegerrequired
  - unreadintegerrequired
- observedAtstringrequired
  RFC 3339 UTC instant; empty when absent.
- revisionintegerrequired
scopeobjectrequired
- serverIdstringrequired
- viewerFencestringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/notifications/unread-count" \
  -H "Authorization: Bearer $PORTICO_API_KEY"