organisations

Get an organisation

The caller's own account, as one merged record: the control plane's account settings joined with the registry-owned avatar_url when the account has a picture — the same shape GET /users/{user_id} carries, so one read gives the details and a pointer to the picture. avatar_url is absent (not null) when there is none; fetch it with the caller's bearer (GET /organisations/{org_id}/avatar). The org_id in the path must be the caller's token org: another account's id is a 404, checked before anything else, so it can never read as a foreign 200. Members and admins may read (settings_view). Honors X-Atlan-Consistency-Token for read-your-own-writes: the token pins the permission check to a revision at least as fresh as a prior write's. A non-2xx control-plane response is surfaced through the registry's problem catalogue.

get/registry/v1/organisations/{org_id}

Request

  • Base URL: https://api.atlan.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.atlan.com/registry/v1/organisations/{org_id}
  • Auth: HTTP bearer

Path parameters

org_idstring required

Stable identifier of the related org resource.

Response

OK

allowed_auth_methodsstring[] nullable

Value of the allowed_auth_methods field.

avatar_urlstring nullable

The registry-native pointer to the account's picture, when it has one. Absent (not null) otherwise, and best-effort: a store that cannot answer drops the key rather than failing the read.

created_atstring nullable

Value of the created_at field.

created_bystring nullable

Value of the created_by field.

idstring required

The account id. Always the path/token org id, never a value from the control-plane body, so a merged record can never name an account other than the one authorized. id on the wire for the reason [OrganisationDto]'s is.

join_policystring nullable

Value of the join_policy field.

namestring nullable

Control-plane fields, each present only when the plane returned it.

restrict_invites_to_domainsboolean nullable

Value of the restrict_invites_to_domains field.

revoke_credentials_on_offboardboolean nullable

Value of the revoke_credentials_on_offboard field.

slugstring nullable

Value of the slug field.

statusstring nullable

Current lifecycle state.

updated_atstring nullable

Value of the updated_at field.

versioninteger nullable

The account's If-Match ETag, read from the control-plane body.

workos_organization_idstring nullable

Stable identifier of the related workos organization resource.

Changes

No recorded changes to this operation across all 1 revision of this API.