Skip to main content
GET
/
notifications
/
{notification_id}
Get a notification
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.paddle.com/notifications/{notification_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "data": {
    "id": "ntf_01hvg8ykjrcdr4jvv9rqcbkhfa",
    "type": "address.created",
    "status": "failed",
    "payload": {
      "data": {
        "id": "add_01hvg8yk4s1aqa37kxspd51bwg",
        "city": null,
        "region": null,
        "status": "active",
        "created_at": "2024-04-15T07:01:11.449Z",
        "first_line": null,
        "updated_at": "2024-04-15T07:01:11.449Z",
        "custom_data": null,
        "customer_id": "ctm_01gzgmxdmgkgc7p94b5kgqq82p",
        "description": null,
        "import_meta": null,
        "postal_code": "10021",
        "second_line": null,
        "country_code": "US"
      },
      "event_id": "evt_01hvg8ykgj5r02vvn44b8hdp8d",
      "event_type": "address.created",
      "occurred_at": "2024-04-15T07:01:11.826666Z",
      "notification_id": "ntf_01hvg8ykjrcdr4jvv9rqcbkhfa"
    },
    "occurred_at": "2024-04-15T07:01:11.826666Z",
    "delivered_at": null,
    "replayed_at": null,
    "origin": "event",
    "last_attempt_at": "2024-04-15T07:19:56.553479Z",
    "retry_at": null,
    "times_attempted": 10,
    "notification_setting_id": "ntfset_01hv6scjn6ex5bej5bdy4w9ax3"
  },
  "meta": {
    "request_id": "50aa6efc-5c11-47f4-8a7a-d13d1ffd85f2"
  }
}

Authorizations

Authorization
string
header
required

Requests are authenticated with API keys. Provide your API key as a Bearer token in the Authorization header.

API keys are assigned permissions, granting them access to entities and operations. Each endpoint may require one or more permissions, defined with the x-permissions extension. Values for include parameters may require specific permissions as defined in the x-enum-permissions extension. See all available permissions in the permission schema or documentation.

Get an API key and select the permissions you need from the Paddle dashboard under Paddle > Developer Tools > Authentication.

Path Parameters

notification_id
string
required

Paddle ID of the notification entity to work with.

Example:

"ntf_01gt261ms8ew72a0vnm5p5ne2q"

Response

OK

data
Notification · object
required

Represents a notification entity.

meta
Meta · object
required

Information about this response.