Skip to main content

Search Organizations

POST 
https://$CUSTOM-DOMAIN/v2/organizations/_search

Search for Organizations. By default, we will return all organization of the instance. Make sure to include a limit and sorting for pagination..

Request​

Body

required

    query

    object

    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: [ORGANIZATION_FIELD_NAME_UNSPECIFIED, ORGANIZATION_FIELD_NAME_NAME]

    Default value: ORGANIZATION_FIELD_NAME_UNSPECIFIED

    queries

    object[]

  • Array [

    • nameQuery

    object

    name stringrequired

    Possible values: non-empty and <= 200 characters

    Name of the organization.

    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 stringrequired

    Possible values: non-empty and <= 200 characters

    Domain used in organization, not necessary primary domain.

    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: [ORGANIZATION_STATE_UNSPECIFIED, ORGANIZATION_STATE_ACTIVE, ORGANIZATION_STATE_INACTIVE, ORGANIZATION_STATE_REMOVED]

    Default value: ORGANIZATION_STATE_UNSPECIFIED

    Current state of the organization.

    idQuery

    object

    id stringrequired

    Possible values: non-empty and <= 200 characters

    Unique identifier of the organization.

    defaultQuery object

  • ]

Responses​

A list of all organizations matching the query

Schema

    details

    object

    totalResult uint64
    processedSequence uint64
    timestamp date-time

    the last time the projection got updated

    sortingColumn string

    Possible values: [ORGANIZATION_FIELD_NAME_UNSPECIFIED, ORGANIZATION_FIELD_NAME_NAME]

    Default value: ORGANIZATION_FIELD_NAME_UNSPECIFIED

    result

    object[]

  • Array [

    • id string

    Unique identifier of the organization.

    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

    changeDate date-time

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

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

    resourceOwner resource_owner is the organization or instance_id an object belongs to (string)
    creationDate date-time
    state string

    Possible values: [ORGANIZATION_STATE_UNSPECIFIED, ORGANIZATION_STATE_ACTIVE, ORGANIZATION_STATE_INACTIVE, ORGANIZATION_STATE_REMOVED]

    Default value: ORGANIZATION_STATE_UNSPECIFIED

    Current state of the organization, for example active, inactive and deleted.

    name string

    Name of the organization.

    primaryDomain string

    Primary domain used in the organization.

  • ]


Request Collapse all
Base URL
https://$CUSTOM-DOMAIN
Auth
Body required
{
  "query": {
    "offset": "0",
    "limit": 100,
    "asc": true
  },
  "sortingColumn": "ORGANIZATION_FIELD_NAME_UNSPECIFIED",
  "queries": [
    {
      "nameQuery": {
        "name": "gigi-giraffe",
        "method": "TEXT_QUERY_METHOD_EQUALS"
      },
      "domainQuery": {
        "domain": "citadel.cloud",
        "method": "TEXT_QUERY_METHOD_EQUALS"
      },
      "stateQuery": {
        "state": "ORGANIZATION_STATE_UNSPECIFIED"
      },
      "idQuery": {
        "id": "69629023906488334"
      },
      "defaultQuery": {}
    }
  ]
}
ResponseClear

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