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 organizations
Create an organization
Retrieve an organization
Update an organization
Delete an organization
Retrieve organization settings
Update organization settings
Set an organization's logo
Remove an organization's logo

List organizations

Lists the organizations the person belongs to, or the one with a slug.

Guide: Create a team and a project

GET
/api/v1/organizations

Authorization

AuthorizationBearer <token>

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

In: header

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

Only the organization with this slug, if the person belongs to it; the page then holds at most one.

Examples

curl -X GET "https://api.voidhash.com/api/v1/organizations" \  -H "Authorization: Bearer vh_sk_..."
{  "data": [    {      "id": "org_w5xk2e7q0lzv3n8b1c4d6f9g",      "name": "Acme",      "slug": "acme",      "logoUrl": null    }  ],  "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": "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

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 Organizations

  • Create an organization POST
  • Retrieve an organization GET
  • Update an organization PATCH
  • Delete an organization DELETE
  • Retrieve organization settings GET
  • Update organization settings PATCH
  • Set an organization's logo PUT
  • Remove an organization's logo DELETE

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

PreviousRetry a runNextCreate an organization

On this page

AuthorizationQuery parametersExamplesResponse bodyErrorsMore in Organizations