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 events

List events

Lists the project's stored events, most recently stored first, optionally only those with a name.

An event sent late, such as by a device that was offline, is listed from when it was stored, so reading from the first page again finds it; an event delivered again with the same id is listed once, at its latest delivery. Events the ingest policy refused are not stored. A secret key lists its own environment's events; a person's own credentials choose with x-environment: production (the default), test or all.

Guide: Events

GET
/api/v1/projects/{projectId}/events

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
name?string

Only events with this exact name.

Examples

curl -X GET "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/events?name=%24paywall_viewed" \  -H "Authorization: Bearer vh_sk_..."
{  "data": [    {      "id": "018f6d2e-4c3a-7b1d-9e5f-2a8c1b0d4e6f",      "projectId": "proj_tz4a98xxat96iws9zmbrgj3a",      "name": "$paywall_viewed",      "timestamp": "2026-03-14T09:25:40.000Z",      "distinctId": "user_8231",      "previousDistinctId": null,      "personId": "person_h7d2k9m4x1c6v8b3n5q0w2e7",      "identityMode": "full",      "sessionId": "018f6d2c-91a4-7c3e-b2d8-5f6a7b8c9d0e",      "properties": {        "location": "onboarding-end",        "paywall": "annual-upsell"      },      "context": {        "platform": "ios",        "app_version": "2.4.0"      },      "source": "sdk",      "trustClass": "untrusted_sdk",      "sentAt": "2026-03-14T09:25:41.000Z",      "receivedAt": "2026-03-14T09:25:41.000Z",      "processedAt": "2026-03-14T09:25:42.000Z",      "captureId": "cap_9d2f5g8h1j4k7l0z3x6c9v2b",      "requestId": "req_m1q4w7e0r3t6y9u2i5o8p1a4"    }  ],  "pageInfo": {    "endCursor": null,    "hasNextPage": false  }}
{  "error": {    "type": "invalid_request",    "code": "invalid_cursor",    "message": "This cursor does not continue the list. Start again without a cursor.",    "param": "cursor"  }}
{  "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

StatustypecodeWhen
400invalid_requestinvalid_cursorFor a malformed cursor.

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

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

PreviousDelete an analytics alertNextRetrieve the ingest policy

On this page

AuthorizationPath parametersQuery parametersExamplesResponse bodyErrors