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
List push configurations
Add a push configuration
Retrieve a push configuration
Update a push configuration
Delete a push configuration

Retrieve a push configuration

Reads one push notification configuration without its credentials.

Guide: Push notifications

GET
/api/v1/projects/{projectId}/push-notification-configurations/{configurationId}

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.

configurationId*string

The configuration's id, push_conf_....

Examples

curl -X GET "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/push-notification-configurations/push_conf_m3n7b1v5c9x2z6l0k4j8h2g6" \  -H "Authorization: Bearer vh_sk_..."
{  "id": "push_conf_m3n7b1v5c9x2z6l0k4j8h2g6",  "projectId": "proj_tz4a98xxat96iws9zmbrgj3a",  "type": "apns",  "name": "Apple Push Notification service",  "key": "com.example.app",  "isEnabled": true,  "configuration": {    "teamId": "A1B2C3D4E5",    "keyId": "K9L8M7N6P5",    "bundleId": "com.example.app",    "environment": "production",    "hasPrivateKey": true  },  "createdAt": "2026-02-05T09:00:00.000Z",  "updatedAt": "2026-02-05T09:04:30.000Z"}
{  "error": {    "type": "invalid_request",    "code": "string",    "message": "string",    "param": "string"  }}
{  "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": "push_notification_configuration_not_found",    "message": "This project has no push notification configuration push_conf_m3n7b1v5c9x2z6l0k4j8h2g6.",    "param": "configurationId"  }}

{  "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

StatustypecodeWhen
404not_foundpush_notification_configuration_not_found—

It can also fail with the errors every operation shares, such as unauthenticated; see Errors.

More in Push configurations

  • List push configurations GET
  • Add a push configuration POST
  • Update a push configuration PATCH
  • Delete a push configuration DELETE

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

PreviousAdd a push configurationNextUpdate a push configuration

On this page

AuthorizationPath parametersExamplesResponse bodyErrorsMore in Push configurations