VoidhashDocs
DevelopersHelp centerGuidesAPI reference
Dashboard
Essentials
API overview
Authentication
Event capture
Push device API
Webhooks
Webhook delivery
Webhook events
Projects & keys
Projects
API keys
Audit log
Customers & access
Persons
Products
Perks
Sandbox
Paywalls
Paywalls
Paywall locations
Components
Component registry
Assets
Experiments & flags
Experiments
Feature flags
Analytics & events
Analytics
Analytics alerts
Events
Ingest policy
VoidQL
Tracking domains
Ads
Ads
Ad accounts
Meta measurement
Payments & stores
Payment providers
Payment provider products
Purchase history imports
Payment sources
Webhooks & notifications
Webhooks
Push notifications
Push configurations
Automations
Organization & team
Organizations
Members
Invitations
Billing
Your account
Profile
Session
Notices
Connected apps
Terms of Service
Developer tools
Schema
SDK
Send a push notification
List push notifications
List a push notification's deliveries

List push notifications

Lists the project's push notifications, newest first, with how many deliveries succeeded, failed or were skipped.

Guide: Push notifications

GET
/api/v1/projects/{projectId}/push-notifications

Authorization

AuthorizationBearer <token>

A project secret key: vh_sk_... for production, vh_sk_test_... for test. Keep it on your servers.

In: header

Path parameters

projectId*string

The project's id, proj_.... A secret key works only in the project it belongs to.

Query parameters

cursor?string

Where the page starts: the pageInfo.endCursor of the previous page. Omit it for the first page.

limit?integer

How many items to return, from 1 to 100. Defaults to 50.

Range1 <= value <= 100

Examples

curl -X GET "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/push-notifications" \  -H "Authorization: Bearer vh_sk_..."
{  "data": [    {      "id": "push_send_r2t6y0u4i8o1p5a9s3d7f1g5",      "status": "succeeded",      "message": {        "title": "Your trial ends tomorrow",        "body": "Keep Pro for $4.99 a month.",        "data": {          "screen": "paywall"        },        "priority": "high"      },      "isMessagePurged": false,      "requestedPersonCount": 0,      "requestedDistinctIdCount": 1,      "unresolvedDistinctIds": [],      "deviceCount": 2,      "succeededCount": 2,      "failedCount": 0,      "skippedCount": 0,      "idempotencyKey": "trial-ending-2026-03-14-user_8231",      "createdAt": "2026-03-14T18:00:00.000Z",      "completedAt": "2026-03-14T18:00:03.000Z"    }  ],  "pageInfo": {    "endCursor": null,    "hasNextPage": false  }}
{  "error": {    "type": "invalid_request",    "code": "invalid_query",    "message": "The request query is invalid: Expected a finite number\n  at [\"limit\"]"  }}
{  "error": {    "type": "unauthenticated",    "code": "invalid_api_key",    "message": "This secret key is not valid."  }}
{  "error": {    "type": "permission_denied",    "code": "permission_denied",    "message": "Insufficient permissions."  }}
{  "error": {    "type": "not_found",    "code": "project_not_found",    "message": "There is no project proj_tz4a98xxat96iws9zmbrgj3a, or this credential cannot use it.",    "param": "projectId"  }}
{  "error": {    "type": "internal",    "code": "internal_error",    "message": "Something went wrong on our side. Try again, and contact support with the Request-Id header if it keeps failing."  }}

Response body

application/json

application/json

application/json

application/json

application/json

application/json

Errors

This operation adds no error codes of its own. It can fail with the errors every operation shares, such as unauthenticated; see Errors.

More in Push notifications

  • Send a push notification POST
  • List a push notification's deliveries GET

Something wrong or missing on this page? Tell us by email or on Discord.

PreviousSend a push notificationNextList a push notification's deliveries

On this page

AuthorizationPath parametersQuery parametersExamplesResponse bodyErrorsMore in Push notifications