Get a notification

curl https://api.tapace.lk/v1/notifications/ntf_Bv6Kp2Wx9Lm4Tq8Rz3Nc \
  -H "Authorization: Bearer $TAPACE_API_KEY"

{
  "object": "notification",
  "id": "ntf_Bv6Kp2Wx9Lm4Tq8Rz3Nc",
  "scope": "template",
  "environment": "test",
  "templateId": "tmpl_Q4vN8xT2mLr7KpZs3Wd1",
  "passId": null,
  "deploymentId": null,
  "deploymentRevision": null,
  "appleText": "Doors open at 7 tonight.",
  "googleTitle": "Doors at 7",
  "googleBody": "Doors open at 7 tonight. See you there!",
  "status": "sent",
  "statusReason": null,
  "scheduledFor": "2026-10-18T13:30:00.000Z",
  "audience": 42,
  "actor": { "id": "cmgx4k2p90001ab12cd34ef56", "name": null, "email": null },
  "totals": {
    "pending": 0,
    "apple": { "delivered": 30, "devices": 31, "notInstalled": 2, "failed": 0, "skipped": 0 },
    "google": { "sent": 9, "limitReached": 1, "notSaved": 0, "failed": 0, "skipped": 0 }
  },
  "delivery": null,
  "createdAt": "2026-10-18T09:00:00.000Z",
  "updatedAt": "2026-10-18T13:30:08.000Z",
  "startedAt": "2026-10-18T13:30:01.000Z",
  "sentAt": "2026-10-18T13:30:08.000Z"
}

GET

notifications

{id}

curl https://api.tapace.lk/v1/notifications/ntf_Bv6Kp2Wx9Lm4Tq8Rz3Nc \
  -H "Authorization: Bearer $TAPACE_API_KEY"

{
  "object": "notification",
  "id": "ntf_Bv6Kp2Wx9Lm4Tq8Rz3Nc",
  "scope": "template",
  "environment": "test",
  "templateId": "tmpl_Q4vN8xT2mLr7KpZs3Wd1",
  "passId": null,
  "deploymentId": null,
  "deploymentRevision": null,
  "appleText": "Doors open at 7 tonight.",
  "googleTitle": "Doors at 7",
  "googleBody": "Doors open at 7 tonight. See you there!",
  "status": "sent",
  "statusReason": null,
  "scheduledFor": "2026-10-18T13:30:00.000Z",
  "audience": 42,
  "actor": { "id": "cmgx4k2p90001ab12cd34ef56", "name": null, "email": null },
  "totals": {
    "pending": 0,
    "apple": { "delivered": 30, "devices": 31, "notInstalled": 2, "failed": 0, "skipped": 0 },
    "google": { "sent": 9, "limitReached": 1, "notSaved": 0, "failed": 0, "skipped": 0 }
  },
  "delivery": null,
  "createdAt": "2026-10-18T09:00:00.000Z",
  "updatedAt": "2026-10-18T13:30:08.000Z",
  "startedAt": "2026-10-18T13:30:01.000Z",
  "sentAt": "2026-10-18T13:30:08.000Z"
}

string

required

The notification ID, starting with ntf_.

The notification object

string

Unique ID, starting with ntf_.

string

pass for a message to one pass, template for an announcement to a template’s passes, or deployment for the message sent with a deployment.

string

test or live.

string

The template whose passes it’s for.

string | null

The pass, for a pass notification.

string | null

The deployment, for a deployment notification. deploymentRevision is the template revision it rolled out.

string | null

The Apple Wallet message.

string | null

The Google Wallet message title. googleBody is its body.

string

Status	Meaning
`scheduled`	Waiting for `scheduledFor`. It can still be changed or cancelled.
`queued`	About to be sent.
`sending`	Being sent to the wallets.
`sent`	Sent to every pass it’s for.
`cancelled`	Cancelled before it was sent.
`dropped`	Not sent. `statusReason` explains why, for example it couldn’t start in time.
`failed`	Sending stopped. `statusReason` explains why.

string | null

When it’s set to send. null for one sent straight away.

integer

How many passes it was sent to, once it’s sent.

object | null

Who sent it: id, name and email. For the API, id is the API key’s ID and the other two are null.

object | null

Progress across all its passes, for a template or deployment notification. null for a pass notification.

Show properties

integer

Passes still being sent to.

object

delivered passes, the devices they reached, notInstalled, failed and skipped.

object

sent, limitReached (added without an alert because of Google’s daily limit), notSaved, failed and skipped.

object | null

How it reached one pass: for a pass notification here, and for each item when you list a pass’s notifications. apple has status, devices and error. google has status, message (sent, limit_reached, failed, …) and error. skipReason explains a skipped pass.

string

When it was created. startedAt and sentAt record when sending started and finished.

Errors

Status	When
`404`	The notification doesn’t exist in this environment.

curl https://api.tapace.lk/v1/notifications/ntf_Bv6Kp2Wx9Lm4Tq8Rz3Nc \
  -H "Authorization: Bearer $TAPACE_API_KEY"

{
  "object": "notification",
  "id": "ntf_Bv6Kp2Wx9Lm4Tq8Rz3Nc",
  "scope": "template",
  "environment": "test",
  "templateId": "tmpl_Q4vN8xT2mLr7KpZs3Wd1",
  "passId": null,
  "deploymentId": null,
  "deploymentRevision": null,
  "appleText": "Doors open at 7 tonight.",
  "googleTitle": "Doors at 7",
  "googleBody": "Doors open at 7 tonight. See you there!",
  "status": "sent",
  "statusReason": null,
  "scheduledFor": "2026-10-18T13:30:00.000Z",
  "audience": 42,
  "actor": { "id": "cmgx4k2p90001ab12cd34ef56", "name": null, "email": null },
  "totals": {
    "pending": 0,
    "apple": { "delivered": 30, "devices": 31, "notInstalled": 2, "failed": 0, "skipped": 0 },
    "google": { "sent": 9, "limitReached": 1, "notSaved": 0, "failed": 0, "skipped": 0 }
  },
  "delivery": null,
  "createdAt": "2026-10-18T09:00:00.000Z",
  "updatedAt": "2026-10-18T13:30:08.000Z",
  "startedAt": "2026-10-18T13:30:01.000Z",
  "sentAt": "2026-10-18T13:30:08.000Z"
}

Getting started

Basics

Guides

Node.js SDK

API keys

Passes

Loyalty cards

Notifications

Templates

Wallet signing

Deployments

Assets

Get a notification

The notification object

Errors

​The notification object

​Errors

The notification object

Errors