Search Organization

Returns a list of organizations that match the requesting filters. All filters are applied with an AND condition.

application/json

application/grpc

application/grpc-web+proto

Request Body required

Search query for lists

query object required

Object unspecific list filters like offset, limit and asc/desc.

offset uint64

limit int64

Maximum amount of events returned. The default is set to 1000 in https://github.com/zitadel/zitadel/blob/new-eventstore/cmd/zitadel/startup.yaml. If the limit exceeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken.

asc boolean

default is descending

sortingColumn the field the result is sorted

Possible values: [ORG_FIELD_NAME_UNSPECIFIED, ORG_FIELD_NAME_NAME]

Default value: ORG_FIELD_NAME_UNSPECIFIED

queries object[]
Array [
nameQuery object
name string
method string
Possible values: [TEXT_QUERY_METHOD_EQUALS, TEXT_QUERY_METHOD_EQUALS_IGNORE_CASE, TEXT_QUERY_METHOD_STARTS_WITH, TEXT_QUERY_METHOD_STARTS_WITH_IGNORE_CASE, TEXT_QUERY_METHOD_CONTAINS, TEXT_QUERY_METHOD_CONTAINS_IGNORE_CASE, TEXT_QUERY_METHOD_ENDS_WITH, TEXT_QUERY_METHOD_ENDS_WITH_IGNORE_CASE]
Default value: TEXT_QUERY_METHOD_EQUALS
defines which text equality method is used
domainQuery object
domain string
method string
Possible values: [TEXT_QUERY_METHOD_EQUALS, TEXT_QUERY_METHOD_EQUALS_IGNORE_CASE, TEXT_QUERY_METHOD_STARTS_WITH, TEXT_QUERY_METHOD_STARTS_WITH_IGNORE_CASE, TEXT_QUERY_METHOD_CONTAINS, TEXT_QUERY_METHOD_CONTAINS_IGNORE_CASE, TEXT_QUERY_METHOD_ENDS_WITH, TEXT_QUERY_METHOD_ENDS_WITH_IGNORE_CASE]
Default value: TEXT_QUERY_METHOD_EQUALS
defines which text equality method is used
stateQuery object
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
]

Request Body required

Search query for lists

query object required

Object unspecific list filters like offset, limit and asc/desc.

offset uint64

limit int64

Maximum amount of events returned. The default is set to 1000 in https://github.com/zitadel/zitadel/blob/new-eventstore/cmd/zitadel/startup.yaml. If the limit exceeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken.

asc boolean

default is descending

sortingColumn the field the result is sorted

Possible values: [ORG_FIELD_NAME_UNSPECIFIED, ORG_FIELD_NAME_NAME]

Default value: ORG_FIELD_NAME_UNSPECIFIED

queries object[]
Array [
nameQuery object
name string
method string
Possible values: [TEXT_QUERY_METHOD_EQUALS, TEXT_QUERY_METHOD_EQUALS_IGNORE_CASE, TEXT_QUERY_METHOD_STARTS_WITH, TEXT_QUERY_METHOD_STARTS_WITH_IGNORE_CASE, TEXT_QUERY_METHOD_CONTAINS, TEXT_QUERY_METHOD_CONTAINS_IGNORE_CASE, TEXT_QUERY_METHOD_ENDS_WITH, TEXT_QUERY_METHOD_ENDS_WITH_IGNORE_CASE]
Default value: TEXT_QUERY_METHOD_EQUALS
defines which text equality method is used
domainQuery object
domain string
method string
Possible values: [TEXT_QUERY_METHOD_EQUALS, TEXT_QUERY_METHOD_EQUALS_IGNORE_CASE, TEXT_QUERY_METHOD_STARTS_WITH, TEXT_QUERY_METHOD_STARTS_WITH_IGNORE_CASE, TEXT_QUERY_METHOD_CONTAINS, TEXT_QUERY_METHOD_CONTAINS_IGNORE_CASE, TEXT_QUERY_METHOD_ENDS_WITH, TEXT_QUERY_METHOD_ENDS_WITH_IGNORE_CASE]
Default value: TEXT_QUERY_METHOD_EQUALS
defines which text equality method is used
stateQuery object
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
]

Request Body required

Search query for lists

query object required

Object unspecific list filters like offset, limit and asc/desc.

offset uint64

limit int64

Maximum amount of events returned. The default is set to 1000 in https://github.com/zitadel/zitadel/blob/new-eventstore/cmd/zitadel/startup.yaml. If the limit exceeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken.

asc boolean

default is descending

sortingColumn the field the result is sorted

Possible values: [ORG_FIELD_NAME_UNSPECIFIED, ORG_FIELD_NAME_NAME]

Default value: ORG_FIELD_NAME_UNSPECIFIED

queries object[]
Array [
nameQuery object
name string
method string
Possible values: [TEXT_QUERY_METHOD_EQUALS, TEXT_QUERY_METHOD_EQUALS_IGNORE_CASE, TEXT_QUERY_METHOD_STARTS_WITH, TEXT_QUERY_METHOD_STARTS_WITH_IGNORE_CASE, TEXT_QUERY_METHOD_CONTAINS, TEXT_QUERY_METHOD_CONTAINS_IGNORE_CASE, TEXT_QUERY_METHOD_ENDS_WITH, TEXT_QUERY_METHOD_ENDS_WITH_IGNORE_CASE]
Default value: TEXT_QUERY_METHOD_EQUALS
defines which text equality method is used
domainQuery object
domain string
method string
Possible values: [TEXT_QUERY_METHOD_EQUALS, TEXT_QUERY_METHOD_EQUALS_IGNORE_CASE, TEXT_QUERY_METHOD_STARTS_WITH, TEXT_QUERY_METHOD_STARTS_WITH_IGNORE_CASE, TEXT_QUERY_METHOD_CONTAINS, TEXT_QUERY_METHOD_CONTAINS_IGNORE_CASE, TEXT_QUERY_METHOD_ENDS_WITH, TEXT_QUERY_METHOD_ENDS_WITH_IGNORE_CASE]
Default value: TEXT_QUERY_METHOD_EQUALS
defines which text equality method is used
stateQuery object
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
]

Responses

• 200
• 400
• 403
• 404
• default

---

list of organizations matching the query

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

details object

totalResult uint64

processedSequence uint64

viewTimestamp date-time

the last time the view got updated

sortingColumn string

Possible values: [ORG_FIELD_NAME_UNSPECIFIED, ORG_FIELD_NAME_NAME]

Default value: ORG_FIELD_NAME_UNSPECIFIED

result object[]
Array [
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
]

{
  "details": {
    "totalResult": "2",
    "processedSequence": "267831",
    "viewTimestamp": "2024-06-11T10:37:15.729Z"
  },
  "sortingColumn": "ORG_FIELD_NAME_UNSPECIFIED",
  "result": [
    {
      "id": "69629023906488334",
      "details": {
        "sequence": "2",
        "creationDate": "2024-06-11T10:37:15.729Z",
        "changeDate": "2024-06-11T10:37:15.729Z",
        "resourceOwner": "69629023906488334"
      },
      "state": "ORG_STATE_UNSPECIFIED",
      "name": "ZITADEL",
      "primaryDomain": "zitadel.cloud"
    }
  ]
}

Schema

Example (from schema)

---

Schema

details object

totalResult uint64

processedSequence uint64

viewTimestamp date-time

the last time the view got updated

sortingColumn string

Possible values: [ORG_FIELD_NAME_UNSPECIFIED, ORG_FIELD_NAME_NAME]

Default value: ORG_FIELD_NAME_UNSPECIFIED

result object[]
Array [
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
]

{
  "details": {
    "totalResult": "2",
    "processedSequence": "267831",
    "viewTimestamp": "2024-06-11T10:37:15.729Z"
  },
  "sortingColumn": "ORG_FIELD_NAME_UNSPECIFIED",
  "result": [
    {
      "id": "69629023906488334",
      "details": {
        "sequence": "2",
        "creationDate": "2024-06-11T10:37:15.729Z",
        "changeDate": "2024-06-11T10:37:15.729Z",
        "resourceOwner": "69629023906488334"
      },
      "state": "ORG_STATE_UNSPECIFIED",
      "name": "ZITADEL",
      "primaryDomain": "zitadel.cloud"
    }
  ]
}

Schema

Example (from schema)

---

Schema

details object

totalResult uint64

processedSequence uint64

viewTimestamp date-time

the last time the view got updated

sortingColumn string

Possible values: [ORG_FIELD_NAME_UNSPECIFIED, ORG_FIELD_NAME_NAME]

Default value: ORG_FIELD_NAME_UNSPECIFIED

result object[]
Array [
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
]

{
  "details": {
    "totalResult": "2",
    "processedSequence": "267831",
    "viewTimestamp": "2024-06-11T10:37:15.730Z"
  },
  "sortingColumn": "ORG_FIELD_NAME_UNSPECIFIED",
  "result": [
    {
      "id": "69629023906488334",
      "details": {
        "sequence": "2",
        "creationDate": "2024-06-11T10:37:15.730Z",
        "changeDate": "2024-06-11T10:37:15.730Z",
        "resourceOwner": "69629023906488334"
      },
      "state": "ORG_STATE_UNSPECIFIED",
      "name": "ZITADEL",
      "primaryDomain": "zitadel.cloud"
    }
  ]
}

invalid list query

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"
    }
  ]
}

Returned when the user does not have permission to access the resource.

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"
    }
  ]
}

Returned when the resource does not exist.

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"
    }
  ]
}

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"
    }
  ]
}

POST /orgs/_search

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/admin/v1

Bearer Token

Content-Type

application/jsonapplication/grpcapplication/grpc-web+proto

Body required

{
  "query": {
    "offset": "0",
    "limit": 100,
    "asc": true
  },
  "sortingColumn": "ORG_FIELD_NAME_UNSPECIFIED",
  "queries": [
    {
      "nameQuery": {
        "name": "ZITADEL",
        "method": "TEXT_QUERY_METHOD_EQUALS"
      },
      "domainQuery": {
        "domain": "citadel.cloud",
        "method": "TEXT_QUERY_METHOD_EQUALS"
      },
      "stateQuery": {
        "state": "ORG_STATE_UNSPECIFIED"
      }
    }
  ]
}

Accept

application/jsonapplication/grpcapplication/grpc-web+proto

curl / cURL

curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/orgs/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "query": {
    "offset": "0",
    "limit": 100,
    "asc": true
  },
  "sortingColumn": "ORG_FIELD_NAME_UNSPECIFIED",
  "queries": [
    {
      "nameQuery": {
        "name": "ZITADEL",
        "method": "TEXT_QUERY_METHOD_EQUALS"
      },
      "domainQuery": {
        "domain": "citadel.cloud",
        "method": "TEXT_QUERY_METHOD_EQUALS"
      },
      "stateQuery": {
        "state": "ORG_STATE_UNSPECIFIED"
      }
    }
  ]
}'

python / requests

curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/orgs/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "query": {
    "offset": "0",
    "limit": 100,
    "asc": true
  },
  "sortingColumn": "ORG_FIELD_NAME_UNSPECIFIED",
  "queries": [
    {
      "nameQuery": {
        "name": "ZITADEL",
        "method": "TEXT_QUERY_METHOD_EQUALS"
      },
      "domainQuery": {
        "domain": "citadel.cloud",
        "method": "TEXT_QUERY_METHOD_EQUALS"
      },
      "stateQuery": {
        "state": "ORG_STATE_UNSPECIFIED"
      }
    }
  ]
}'

go / native

curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/orgs/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "query": {
    "offset": "0",
    "limit": 100,
    "asc": true
  },
  "sortingColumn": "ORG_FIELD_NAME_UNSPECIFIED",
  "queries": [
    {
      "nameQuery": {
        "name": "ZITADEL",
        "method": "TEXT_QUERY_METHOD_EQUALS"
      },
      "domainQuery": {
        "domain": "citadel.cloud",
        "method": "TEXT_QUERY_METHOD_EQUALS"
      },
      "stateQuery": {
        "state": "ORG_STATE_UNSPECIFIED"
      }
    }
  ]
}'

nodejs / axios

curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/orgs/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "query": {
    "offset": "0",
    "limit": 100,
    "asc": true
  },
  "sortingColumn": "ORG_FIELD_NAME_UNSPECIFIED",
  "queries": [
    {
      "nameQuery": {
        "name": "ZITADEL",
        "method": "TEXT_QUERY_METHOD_EQUALS"
      },
      "domainQuery": {
        "domain": "citadel.cloud",
        "method": "TEXT_QUERY_METHOD_EQUALS"
      },
      "stateQuery": {
        "state": "ORG_STATE_UNSPECIFIED"
      }
    }
  ]
}'

ruby / Net::HTTP

curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/orgs/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "query": {
    "offset": "0",
    "limit": 100,
    "asc": true
  },
  "sortingColumn": "ORG_FIELD_NAME_UNSPECIFIED",
  "queries": [
    {
      "nameQuery": {
        "name": "ZITADEL",
        "method": "TEXT_QUERY_METHOD_EQUALS"
      },
      "domainQuery": {
        "domain": "citadel.cloud",
        "method": "TEXT_QUERY_METHOD_EQUALS"
      },
      "stateQuery": {
        "state": "ORG_STATE_UNSPECIFIED"
      }
    }
  ]
}'

csharp / RestSharp

curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/orgs/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "query": {
    "offset": "0",
    "limit": 100,
    "asc": true
  },
  "sortingColumn": "ORG_FIELD_NAME_UNSPECIFIED",
  "queries": [
    {
      "nameQuery": {
        "name": "ZITADEL",
        "method": "TEXT_QUERY_METHOD_EQUALS"
      },
      "domainQuery": {
        "domain": "citadel.cloud",
        "method": "TEXT_QUERY_METHOD_EQUALS"
      },
      "stateQuery": {
        "state": "ORG_STATE_UNSPECIFIED"
      }
    }
  ]
}'

php / cURL

curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/orgs/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "query": {
    "offset": "0",
    "limit": 100,
    "asc": true
  },
  "sortingColumn": "ORG_FIELD_NAME_UNSPECIFIED",
  "queries": [
    {
      "nameQuery": {
        "name": "ZITADEL",
        "method": "TEXT_QUERY_METHOD_EQUALS"
      },
      "domainQuery": {
        "domain": "citadel.cloud",
        "method": "TEXT_QUERY_METHOD_EQUALS"
      },
      "stateQuery": {
        "state": "ORG_STATE_UNSPECIFIED"
      }
    }
  ]
}'

java / OkHttp

curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/orgs/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "query": {
    "offset": "0",
    "limit": 100,
    "asc": true
  },
  "sortingColumn": "ORG_FIELD_NAME_UNSPECIFIED",
  "queries": [
    {
      "nameQuery": {
        "name": "ZITADEL",
        "method": "TEXT_QUERY_METHOD_EQUALS"
      },
      "domainQuery": {
        "domain": "citadel.cloud",
        "method": "TEXT_QUERY_METHOD_EQUALS"
      },
      "stateQuery": {
        "state": "ORG_STATE_UNSPECIFIED"
      }
    }
  ]
}'

powershell / RestMethod

curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/orgs/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "query": {
    "offset": "0",
    "limit": 100,
    "asc": true
  },
  "sortingColumn": "ORG_FIELD_NAME_UNSPECIFIED",
  "queries": [
    {
      "nameQuery": {
        "name": "ZITADEL",
        "method": "TEXT_QUERY_METHOD_EQUALS"
      },
      "domainQuery": {
        "domain": "citadel.cloud",
        "method": "TEXT_QUERY_METHOD_EQUALS"
      },
      "stateQuery": {
        "state": "ORG_STATE_UNSPECIFIED"
      }
    }
  ]
}'