List notifications with cursor pagination

GET

/v1/notifications

curl --request GET \
  --url 'https://your-notavia-host/v1/notifications?status=queued&limit=20' \
  --header 'Authorization: Bearer <token>'

• Self-hosted deployment

Authorizations

• apiKey

Parameters

Query Parameters

status

string

Allowed values: queued sending sent failed suppressed delivered bounced complained

recipient

string

created_after

string format: date-time

created_before

string format: date-time

limit

integer

default: 20 >= 1 <= 100

cursor

string

Responses

200

Paginated list of notifications.

Media type application/json

object

data

Array<object>

object

id

string format: uuid

status

string

Allowed values: queued sending sent failed suppressed delivered bounced complained

channel

Notification channel identifier.

string

Allowed values: email in_app webhook sms slack teams discord

recipient

object

address

string

nullable

name

string

nullable

subject

string

nullable

html_body

string

nullable

text_body

string

nullable

template_key

string

nullable

template_data

object

key

additional properties

any

idempotency_key

string

nullable

action_url

string

nullable

attempt_count

integer

created_at

string format: date-time

events

Array<object>

object

type

A step in the message’s life: Queued, Sending, Sent, Retrying, Failed, Delivered, Bounced, Complained, DeliveryDelayed, Opened, Clicked, FailedOver, AttemptFailed. FailedOver means a provider refused the message and the next provider in your chain was tried; AttemptFailed means a provider refused it and there was nowhere left to go. Deliberately an open string, not an enum — new values are added over time and must not break a generated client.

string

occurred_at

string format: date-time

detail

string

nullable

suppression_reason

string

nullable

attachments

Metadata for files that were attached to this email notification. Bytes are purged after delivery; the purged flag indicates whether this has occurred. Omitted when the notification had no attachments.

Array<object>

object

filename

Original file name.

string

content_type

MIME type of the file.

string

size_bytes

File size in bytes.

integer format: int64

purged

True when the attachment bytes have been deleted from ephemeral storage after delivery. The metadata fields (filename, content_type, size_bytes) are always retained.

boolean

next_cursor

string

nullable

Example

{
  "data": [
    {
      "status": "queued",
      "channel": "email",
      "events": [
        {
          "type": "FailedOver"
        }
      ]
    }
  ]
}

400

Validation or request error.

Media type application/json

object

error

required

object

type

required

string

code

required

string

message

required

string

param

string

nullable

Example ^generated

{
  "error": {
    "type": "example",
    "code": "example",
    "message": "example",
    "param": "example"
  }
}

401

Missing or invalid credentials.

Media type application/json

object

error

required

object

type

required

string

code

required

string

message

required

string

param

string

nullable

Example ^generated

{
  "error": {
    "type": "example",
    "code": "example",
    "message": "example",
    "param": "example"
  }
}

403

Credentials do not have the required scope.

Media type application/json

object

error

required

object

type

required

string

code

required

string

message

required

string

param

string

nullable

Example ^generated

{
  "error": {
    "type": "example",
    "code": "example",
    "message": "example",
    "param": "example"
  }
}