List notifications

Returns a cursor-paginated list of broadcasts in the calling organization, newest first.

Useful for a campaign history dashboard: each item carries current status + stats, so one call renders the whole history with live delivery counters.

See Pagination for the cursor pattern.

Scope: notifications:read.

GET /v1/notifications

List notifications

cURL

curl --request GET \
  --url https://api.vexioncards.one/v1/notifications \
  --header 'Authorization: Bearer <token>'

200

Campaign history

{
  "object": "list",
  "url": "/v1/notifications",
  "data": [
    {
      "id": "ntf_01J9P0G7K9C0RYHXJ2K7A4N5MZ",
      "object": "notification",
      "title": {
        "en": "Summer special menu"
      },
      "body": {
        "en": "Try the new lime lemonade for 2.50 EUR."
      },
      "audience": {
        "card_ids": [
          "crd_sophcrprtvpmmnwxah2lomnkee"
        ]
      },
      "status": "completed",
      "schedule_at": null,
      "sent_at": 1782134401,
      "stats": {
        "total": 121,
        "audience_resolved_count": 121,
        "apple_wallet": {
          "total": 98,
          "delivered": 96,
          "failed": 2
        },
        "google_wallet": {
          "total": 23,
          "delivered": 22,
          "failed": 1
        },
        "delivered": 118,
        "failed": 3
      },
      "created_at": 1782134400,
      "completed_at": 1782134522,
      "request_id": "req_01J9P0G7K9C0RYHXJ2K7A4N5MZ"
    }
  ],
  "has_more": false
}

Authorizations

Authorization · string · header · required

Your secret API key as a Bearer token: Authorization: Bearer vxn_sk_.... Keys are created and scoped in the dashboard - see Authentication.

Query Parameters

status · enum<string>

Lifecycle filter - same vocabulary as Notification.status.

Available options: queued, scheduled, processing, completed, partial, failed, cancelled

created[gte] · integer string<date-time>

Lower bound on created_at - unix seconds or ISO-8601 (inclusive).

created[lte] · integer string<date-time>

Upper bound on created_at - unix seconds or ISO-8601 (inclusive).

limit · integer · default: 25

1-100. Default 25.

Required range: 1 <= x <= 100

starting_after · string

Cursor - the ntf_ id of the last item on the previous page (forward). Numeric offset or page parameters are not supported; cursors are the only supported paging mechanism.

Pattern: ^ntf_[A-Za-z0-9]+$

ending_before · string

Reverse cursor - returns items before this ntf_ id.

Pattern: ^ntf_[A-Za-z0-9]+$

Response

200

application/json

Paginated notification list.

Standard cursor-pagination envelope - see Pagination.

object · enum<string> · required

Always "list".

Available options: list

data · object[] · required

Array of the requested resource type.

Show child attributes

has_more · boolean · required

True when more pages exist.

next_cursor · string | null

Cursor for the next page in the direction you are already paging, or null when this page ends the collection. has_more: true always comes with a non-null next_cursor.

Feed it back to the SAME parameter you used: starting_after when paging forward (the default), or ending_before when paging backward. Treat it as opaque and do not parse it.

You no longer need to take the last object's id yourself. That still works and is unchanged, but deriving the cursor from the page put the burden of knowing the sort direction on you, and it broke silently on any endpoint whose cursor is not the object id.

Example:

"cus_iofv5j4hn6bphinmmyat27tc5y"

url · string

Stable collection URL.