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 notices
Count unread notices
Mark notices read
Archive notices
Unarchive notices
Retrieve notice preferences
Update notice preferences

List notices

Lists the person's notices in the organization, newest first; isArchived=true lists the archive instead.

Guide: Notices

GET
/api/v1/organizations/{organizationId}/notices

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

organizationId*string

The organization's id, org_....

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

true lists the archive instead of the inbox. Defaults to false.

Value in

  • "true"
  • "false"

Examples

curl -X GET "https://api.voidhash.com/api/v1/organizations/org_w5xk2e7q0lzv3n8b1c4d6f9g/notices" \  -H "Authorization: Bearer vh_sk_..."
{  "data": [    {      "id": "notice_p4r7t0y3u6i9o2a5s8d1f4g7",      "organizationId": "org_w5xk2e7q0lzv3n8b1c4d6f9g",      "type": "billing.usage_limit",      "category": "billing",      "title": "Events at 80% of this period's allowance",      "body": "Acme has used 80% of the events its plan includes this period.",      "isUrgent": false,      "createdAt": "2026-03-20T06:00:00.000Z",      "readAt": null,      "archivedAt": null,      "resolvedAt": null    }  ],  "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": "organization_not_found",    "message": "There is no organization org_w5xk2e7q0lzv3n8b1c4d6f9g, or this credential cannot use it.",    "param": "organizationId"  }}
{  "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 cursor this endpoint did not return.

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

More in Notices

  • Count unread notices GET
  • Mark notices read POST
  • Archive notices POST
  • Unarchive notices POST
  • Retrieve notice preferences GET
  • Update notice preferences PATCH

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

PreviousSign out the CLINextCount unread notices

On this page

AuthorizationPath parametersQuery parametersExamplesResponse bodyErrorsMore in Notices