Skip to content
Hayonix

API reference · Organizations

Get an organization

GET/v1/orgs/{org_id}
Console sessionorg:readOrganization

Returns the organization with your role in it (role is null when the caller is an API key).

Console session only: no API key can be granted the org:read permission it needs. Requires the org:read permission (a key's scope, or a role that includes it).

Request

Path parameters

  • org_idstring

    Your organization. The SDKs and the CLI fill it in from the API key.

    ID with prefix org_

Response

200 Organization — The organization

  • objectstringrequired

    Always `organization`: the type of this object

    One oforganization

  • idstringrequired

    Unique ID (`org_…`)

    ID with prefix org_

  • namestringrequired

    Its name

  • slugstringrequired

    Short URL-safe name, unique across the platform

  • rolestring | nullrequired

    Your role in this organization; null when the caller is an API key

    One ofowneradmindeveloperbillingviewer

  • created_atstring (date-time)required

    When it was created (ISO 8601, UTC)

Example response
Example response
{
  "object": "organization",
  "id": "org_01jc5zq4m8k3v6x9t2w7r0b1e4",
  "name": "string",
  "slug": "string",
  "role": "owner",
  "created_at": "2026-01-01T00:00:00.000Z"
}

Errors

Errors use the standard envelope. What this operation can answer:

Errors
StatusTypeWhen
401authentication_errorThe key or session is missing, revoked or expired.
403permission_errorThe credential lacks the permission this needs, or the organization is suspended.
429rate_limit_error rate_limitedToo many requests; retry after retry-after seconds.