List API keys

Lists the project's keys, publishable first, optionally only one type.

A secret key's own value is never listed.

Guide: API keys

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

type?string

Only keys of this type: publishable or secret.

Value in

"publishable"
"secret"

environment?string

Only keys for this environment: production or test.

Value in

"production"
"test"

Examples

curl -X GET "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/api-keys" \  -H "Authorization: Bearer vh_sk_..."

{  "data": [    {      "id": "api_sk_r6t9y2u5i8o1p4a7s0d3f6g9",      "projectId": "proj_tz4a98xxat96iws9zmbrgj3a",      "name": "Production backend",      "type": "secret",      "environment": "production",      "prefix": "vh_sk_",      "end": "f3Qa",      "rawKey": null,      "scopes": [        "project:read",        "project:persons:write",        "project:entitlements:read"      ],      "expiresAt": null,      "lastUsedAt": "2026-03-14T09:26:00.000Z",      "previousKeyExpiresAt": null,      "createdAt": "2026-02-01T08:00:00.000Z"    },    {      "id": "api_pk_t8y1u4i7o0p3a6s9d2f5g8h1",      "projectId": "proj_tz4a98xxat96iws9zmbrgj3a",      "name": "iOS app",      "type": "publishable",      "environment": "production",      "prefix": "vh_pk_",      "end": "7KdM",      "rawKey": "vh_pk_...",      "scopes": null,      "expiresAt": null,      "lastUsedAt": null,      "previousKeyExpiresAt": null,      "createdAt": "2026-02-01T08:00:00.000Z"    }  ],  "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": "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`

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 API keys

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

List API keys

Lists the project's keys, publishable first, optionally only one type.

A secret key's own value is never listed.

Guide: API keys

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

type?string

Only keys of this type: publishable or secret.

Value in

"publishable"
"secret"

environment?string

Only keys for this environment: production or test.

Value in

"production"
"test"

Examples

curl -X GET "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/api-keys" \  -H "Authorization: Bearer vh_sk_..."

{  "data": [    {      "id": "api_sk_r6t9y2u5i8o1p4a7s0d3f6g9",      "projectId": "proj_tz4a98xxat96iws9zmbrgj3a",      "name": "Production backend",      "type": "secret",      "environment": "production",      "prefix": "vh_sk_",      "end": "f3Qa",      "rawKey": null,      "scopes": [        "project:read",        "project:persons:write",        "project:entitlements:read"      ],      "expiresAt": null,      "lastUsedAt": "2026-03-14T09:26:00.000Z",      "previousKeyExpiresAt": null,      "createdAt": "2026-02-01T08:00:00.000Z"    },    {      "id": "api_pk_t8y1u4i7o0p3a6s9d2f5g8h1",      "projectId": "proj_tz4a98xxat96iws9zmbrgj3a",      "name": "iOS app",      "type": "publishable",      "environment": "production",      "prefix": "vh_pk_",      "end": "7KdM",      "rawKey": "vh_pk_...",      "scopes": null,      "expiresAt": null,      "lastUsedAt": null,      "previousKeyExpiresAt": null,      "createdAt": "2026-02-01T08:00:00.000Z"    }  ],  "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": "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`

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 API keys

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

List API keys

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

List API keys

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`