Get Organization By Domain

Search an organization by the domain, overall organizations. The domain must match exactly.

Query Parameters

domain string required

Responses

• 200
• default

---

A successful response.

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

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

{
  "org": {
    "id": "69629023906488334",
    "details": {
      "sequence": "2",
      "creationDate": "2024-03-27T10:05:51.049Z",
      "changeDate": "2024-03-27T10:05:51.049Z",
      "resourceOwner": "69629023906488334"
    },
    "state": "ORG_STATE_UNSPECIFIED",
    "name": "ZITADEL",
    "primaryDomain": "zitadel.cloud"
  }
}

Schema

Example (from schema)

---

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

{
  "org": {
    "id": "69629023906488334",
    "details": {
      "sequence": "2",
      "creationDate": "2024-03-27T10:05:51.049Z",
      "changeDate": "2024-03-27T10:05:51.049Z",
      "resourceOwner": "69629023906488334"
    },
    "state": "ORG_STATE_UNSPECIFIED",
    "name": "ZITADEL",
    "primaryDomain": "zitadel.cloud"
  }
}

Schema

Example (from schema)

---

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

{
  "org": {
    "id": "69629023906488334",
    "details": {
      "sequence": "2",
      "creationDate": "2024-03-27T10:05:51.049Z",
      "changeDate": "2024-03-27T10:05:51.049Z",
      "resourceOwner": "69629023906488334"
    },
    "state": "ORG_STATE_UNSPECIFIED",
    "name": "ZITADEL",
    "primaryDomain": "zitadel.cloud"
  }
}

An unexpected error response.

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

GET /global/orgs/_by_domain

Authorization

name: OAuth2type: oauth2scopes: openid,urn:zitadel:iam:org:project:id:zitadel:audflows: {
  "authorizationCode": {
    "authorizationUrl": "$CUSTOM-DOMAIN/oauth/v2/authorize",
    "tokenUrl": "$CUSTOM-DOMAIN/oauth/v2/token",
    "scopes": {
      "openid": "openid",
      "urn:zitadel:iam:org:project:id:zitadel:aud": "urn:zitadel:iam:org:project:id:zitadel:aud"
    }
  }
}

Request

Base URL

https://$CUSTOM-DOMAIN/management/v1

Bearer Token

domain — query required

Accept

application/jsonapplication/grpcapplication/grpc-web+proto

curl / cURL

curl -L -X GET 'https://$CUSTOM-DOMAIN/management/v1/global/orgs/_by_domain' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

python / requests

curl -L -X GET 'https://$CUSTOM-DOMAIN/management/v1/global/orgs/_by_domain' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

go / native

curl -L -X GET 'https://$CUSTOM-DOMAIN/management/v1/global/orgs/_by_domain' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

nodejs / axios

curl -L -X GET 'https://$CUSTOM-DOMAIN/management/v1/global/orgs/_by_domain' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

ruby / Net::HTTP

curl -L -X GET 'https://$CUSTOM-DOMAIN/management/v1/global/orgs/_by_domain' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

csharp / RestSharp

curl -L -X GET 'https://$CUSTOM-DOMAIN/management/v1/global/orgs/_by_domain' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

php / cURL

curl -L -X GET 'https://$CUSTOM-DOMAIN/management/v1/global/orgs/_by_domain' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

java / OkHttp

curl -L -X GET 'https://$CUSTOM-DOMAIN/management/v1/global/orgs/_by_domain' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

powershell / RestMethod

curl -L -X GET 'https://$CUSTOM-DOMAIN/management/v1/global/orgs/_by_domain' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'