Organizations

Get an organization.

Changed on

Returns the details (name, slug, icon, and related metadata) for the organization identified by orgId. The authenticated user must be a member.

get/api/v1/orgs/{orgId}

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

orgIdstring required

Response

OK

idstring required

Stable organization identifier.

slugstring nullable required

Organization slug.

displayNamestring required

Human-readable organization name.

iconUrlstring nullable required

Optional organization icon data URL.

rolestring nullable required

Current user's role in the organization, when available.

createdAtUtcstring date-time required

UTC timestamp when the organization was created.

activatedAtUtcstring date-time nullable required

UTC timestamp when the organization became active.

autoInviteSameDomainEnabledboolean required

Whether same-domain onboarding is enabled.

autoInviteSameDomainstring nullable required

Normalized domain currently claimed for auto-invites.

autoInviteDefaultRolestring required

Role assigned to auto-created same-domain invitations.

autoInviteSameDomainCanEnableboolean required

Whether the organization can enable same-domain onboarding.

autoInviteSameDomainBlockReasonstring nullable required

Reason enabling is blocked, when any.

Changes

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status