The searchOrganizations() GraphQL query is used to get paginated search results. This is a root operation.

For more information on organization settings, see the Organization Settings documentation page.


Below is the syntax for the searchOrganizations() query field:

      searchFilter: string
      sortBy: Organizations__SortBy!
      typeFilter: [Organizations__SearchEntryType!]
      subscriptionFilter: [Organizations__Subscription!]
      orderBy: OrderBy = ASC
      skip: integer = 0
      limit: integer = 50
   ): OrganizationSearchResultSet!

Given Datatypes

The given datatype, Organizations__SortBy is an enumerated list: UserCount, Name Volume, ViewCount Subscription, or CreatedAt.

The given datatype, Organizations__SearchEntryType is another enumerated list: organization(), repository() View, or user().

The given datatype, Organizations__Subscription is also an enumerated list: Paying, Trial, PreTrial, PostTrial, UnlimitedPoC, ClusterOwner, Complementary, OnPremMonitor, MissingTOSAcceptance, CommunityLocked, CommunityUnlocked, Partner, Internal, Churned, or Unknown.

Returned Datatypes

The returned datatype OrganizationSearchResultSet has its own parameters. Below is a list of them along with their datatypes and a description of each:

Table: OrganizationSearchResultSet

totalResultsintegeryes The total number of matching results.
results[OrganizationSearchResultEntry]yes The paginated result set (see OrganizationSearchResultEntry Table).

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.