Skip to main content

Search Organization

POST 
https://$CUSTOM-DOMAIN/admin/v1/orgs/_search

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

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 (string)

    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

    idQuery

    object

    id string

  • ]

Responses​

list of organizations matching the query

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 (string)
    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

  • ]

curl -L 'https://$CUSTOM-DOMAIN/admin/v1/orgs/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "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"
      },
      "idQuery": {
        "id": "69629023906488334"
      }
    }
  ]
}'
Request Collapse all
Base URL
https://$CUSTOM-DOMAIN/admin/v1
Auth
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"
      },
      "idQuery": {
        "id": "69629023906488334"
      }
    }
  ]
}
ResponseClear

Click the Send API Request button above and see the response here!