Hoppa till innehållet

List the streams

GET/v1/streams

TypeScript sendora.streams.list()

Python sendora.streams.list()

Key sk_… a server key

Every stream of the server, archived ones included, oldest first.

Responses

200Every stream of the server, archived ones included, oldest first.

  • streamsarray of objectrequired
    • streamIdstring (uuid)required

      What a send names as streamId.

    • kind"transactional" | "broadcast" | "inbound"required

      transactional for mail the recipient expects; broadcast for mail to many; inbound for mail the server receives.

    • namestring (at least 1, at most 100 characters)required

      The name given at creation, unique within the server.

    • isDefaultbooleanrequired

      The stream a send without a streamId goes on; one per server, transactional.

    • createdAtstring (date-time)required
    • archivedAtstring (date-time) or nullrequired

      Set once archived; the stream then takes no new messages.

    • pausedAtstring (date-time) or nullrequired

      Set while Sendora has paused the stream after complaints; it takes no messages until support has resumed it.

    • inboundAddressstring or nullrequired

      The address of an inbound stream, its id on inbound.sendora.se; mail sent there is received on the stream. Null on every other kind.

    • contentRetentionDaysinteger (1 to 30) or nullrequired

      How many days an inbound stream keeps received content, 1 to 30; null means the default of 30. Null on every other kind.

Example (37 lines)
{
  "streams": [
    {
      "streamId": "3d1a2b4c-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
      "kind": "transactional",
      "name": "transactional",
      "isDefault": true,
      "createdAt": "2026-09-15T12:00:00.000Z",
      "archivedAt": null,
      "pausedAt": null,
      "inboundAddress": null,
      "contentRetentionDays": null
    },
    {
      "streamId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "kind": "transactional",
      "name": "Notices",
      "isDefault": false,
      "createdAt": "2026-09-16T12:00:00.000Z",
      "archivedAt": null,
      "pausedAt": null,
      "inboundAddress": null,
      "contentRetentionDays": null
    },
    {
      "streamId": "9b2f7c41-3e5d-4a8b-9c1e-2d3f4a5b6c7d",
      "kind": "inbound",
      "name": "Support",
      "isDefault": false,
      "createdAt": "2026-09-20T12:00:00.000Z",
      "archivedAt": null,
      "pausedAt": null,
      "inboundAddress": "9b2f7c413e5d4a8b9c1e2d3f4a5b6c7d@inbound.sendora.se",
      "contentRetentionDays": 14
    }
  ]
}

Errors

Every error answers error, the code, and message, a sentence for a person. A code that adds fields is shown in full below the table.

CodeStatusMeaning
unauthorized401The key is missing, malformed or revoked.
wrong_token_kind403The key is of the other kind: a server key (sk_) where an account key (ak_) is needed, or the reverse. The message names the kind the operation takes.