Skip to main content

Get Organization By ID​

Returns an organization by its ID. Make sure the user has the permissions to access the organization.

Path Parameters
  • id string required
Responses

requested org found

Schema
  • org object
  • id string
  • details object
  • sequence uint64

    on read: the sequence of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

  • creationDate date-time

    on read: the timestamp of the first event of the object

    on create: the timestamp of the event(s) added by the manipulation

  • changeDate date-time

    on read: the timestamp of the last event reduced by the projection

    on manipulation: the

  • resourceOwner resource_owner is the organization an object belongs to
  • state string

    Possible values: [ORG_STATE_UNSPECIFIED, ORG_STATE_ACTIVE, ORG_STATE_INACTIVE, ORG_STATE_REMOVED]

    Default value: ORG_STATE_UNSPECIFIED

    current state of the organization

  • name string
  • primaryDomain string
GET /orgs/:id

Authorization

type: oauth2flow: authorizationCodescopes: openid,urn:zitadel:iam:org:project:id:zitadel:aud

Request

Base URL
https://$ZITADEL_DOMAIN/admin/v1
Bearer Token
id — path required
Accept
curl -L -X GET 'https://$ZITADEL_DOMAIN/admin/v1/orgs/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'