hierarchy

Read one organisation.

Changed on

Tenant-scoped at org depth, unlike the create and list operations above: an organisation the caller may not reach answers exactly like one that does not exist, which is what "unauthorized access at each level returns the uniform nonexistent shape" requires of the top level too. There is therefore no 403 on this route — a refusal is a 404.

get/api/v1/orgs/{org}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/orgs/{org}
  • Auth: HTTP bearer

Response

The organisation.

idstring required

A prefixed UUIDv7, e.g. org_0198….

namestring required
activeboolean required
metadataobject nullable
created_atstring date-time required

RFC 3339 UTC, microsecond precision.

origin'manual' | 'registration' required

How the org came to exist (#585 d8): manual (an operator's create) or registration (a sign-up under a registration policy, a self-served org). Typed on the row, never editable.

registration_policy_idstring nullable

The registration policy that minted the org, a trail pointer with no foreign key (the org keeps it after the policy is deleted); null for a manual org.

Changes

  • 54b2780eec85Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • f84a1cd8a05aRevision changes
    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status