List deliveries

GET/v1/deliveries

Authorization

ApiKeyAuth

AuthorizationBearer <token>

API key authentication. Keys are prefixed with environment:

npk_live_ for production
npk_test_ for testing/staging

In: header

Query Parameters

cursor?string

Pagination cursor for next page

limit?integer

Maximum number of items to return

Default20

Range1 <= value <= 100

subscriptionId?string

Filter by subscription ID

messageId?string

Filter by message ID

status?string

Filter by delivery status

Value in"pending" | "delivered" | "failed" | "retrying"

Response Body

`application/json`

curl -X GET "https://api.npayload.com/v1/deliveries"

{
  "data": [
    {
      "id": "string",
      "messageId": "string",
      "subscriptionId": "string",
      "status": "pending",
      "attempts": 0,
      "lastAttemptAt": "2019-08-24T14:15:22Z",
      "nextRetryAt": "2019-08-24T14:15:22Z",
      "response": {
        "status": 0,
        "body": "string",
        "latencyMs": 0
      },
      "createdAt": "2019-08-24T14:15:22Z"
    }
  ],
  "pagination": {
    "cursor": "string",
    "hasMore": true
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key"
  }
}

Was this page helpful?

List deliveries

Authorization

Query Parameters

Response Body

200application/json

401application/json

`application/json`

`application/json`