Retrieve an organization

Reads one organization.

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

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

On this page

Authorization Path parameters Examples Response body Errors More in Organizations

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_....

Examples

curl -X GET "https://api.voidhash.com/api/v1/organizations/org_w5xk2e7q0lzv3n8b1c4d6f9g" \  -H "Authorization: Bearer vh_sk_..."

{  "id": "org_w5xk2e7q0lzv3n8b1c4d6f9g",  "name": "Acme",  "slug": "acme",  "logoUrl": null}

{  "error": {    "type": "invalid_request",    "code": "string",    "message": "string",    "param": "string"  }}

{  "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."  }}

Retrieve an organization

Errors

More in Organizations

Retrieve an organization

Errors

More in Organizations

Authorization

Path parameters

Examples

Response body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Retrieve an organization

Retrieve an organization

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`