PorticoDocs

Events

Generated events operations.

GET/v1/eventsRead the authorized event ring by long-poll or server-sent streamread
Audience
Integrations · Native API
Authorization
API key or personal access token with the read scope, or a signed-in session
OpenAPI operation ID
get_events

Parameters

NameInTypeDescription
afterquerystring
waitMsquerystring

Responses

200Successapplication/json

Example
{
  "events": [
    {
      "at": "2026-10-18T19:30:00Z",
      "id": "id_8h2k4q",
      "type": "capacity.changed",
      "variant": "capacity"
    }
  ],
  "more": true,
  "nextAfter": "string"
}
Schema
  • eventsarray of objectrequired
    • atstringrequired
    • idstringrequiredlength 1–128
    • type"capacity.changed"required
    • variant"capacity"required
  • morebooleanrequired
  • nextAfterstringrequired

defaultRequest refused or unavailableapplication/json

Example
{
  "error": {
    "code": "string",
    "message": "string"
  }
}
Schema
  • errorobjectrequired
    • codestringrequired
    • messagestringrequired

Error codesunauthorizedinvalid_requestinvalid_cursorevent_wait_limitevent_stream_existsstream_unavailableinternaldatabase_busy

Example request

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