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
Retrieve the session
Sign out the CLI

Retrieve the session

Describes the credential the request is made with: its kind (dashboard_session, cli_key, mcp_client or secret_key), the person it acts for, and the organizations and projects it can use.

Works with every credential.

Guide: Verify a credential

GET
/api/v1/session

Authorization

AuthorizationBearer <token>

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

In: header

Examples

curl -X GET "https://api.voidhash.com/api/v1/session" \  -H "Authorization: Bearer vh_sk_..."
{  "kind": "secret_key",  "person": null,  "connectedAppId": null,  "isReadOnly": false,  "organizations": [],  "projects": [    {      "id": "proj_tz4a98xxat96iws9zmbrgj3a",      "organizationId": "org_w5xk2e7q0lzv3n8b1c4d6f9g",      "name": "Acme Fitness",      "slug": "acme-fitness"    }  ]}
{  "error": {    "type": "invalid_request",    "code": "string",    "message": "string",    "param": "string"  }}
{  "error": {    "type": "unauthenticated",    "code": "session_ended",    "message": "This app was disconnected or went unused too long. Sign it in again."  }}
{  "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

Errors

StatustypecodeWhen
401unauthenticatedsession_endedWhen the connected app was disconnected or went unused too long.

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

More in Session

  • Sign out the CLI DELETE

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

PreviousRemove your pictureNextSign out the CLI

On this page

AuthorizationExamplesResponse bodyErrorsMore in Session