Quick Search GraphQL API

Quick Search returns ranked records across the entity types configured for an organization. Clients should load the entity configuration first because it defines labels, icons, display templates, and how each result opens.

Entity configuration

query QuickSearchEntities($organizationId: Int!) {
  quickSearchEntities(organizationId: $organizationId) {
    entityName
    entityKind
    groupLabel
    icon
    order
    display
    open
  }
}

groupLabel, display, and open are map values. display can provide title, subtitle, and badge templates. open provides either a navigate route template or a dialog name. Render groups by ascending order.

Search

query QuickSearch($organizationId: Int!, $query: String!, $entityNames: [String!], $take: Int!) {
  quickSearch(organizationId: $organizationId, query: $query, entityNames: $entityNames, take: $take) {
    groups {
      entityName
      total
      hasMore
      partial
      items { key matchRank data }
    }
  }
}

Parameter	Type	Description
organizationId	Int!	Organization scope.
query	String!	User-entered search text.
entityNames	[String!]	Optional subset of configured entity names.
take	Int!	Maximum results per group; defaults to 5.

Each group reports its complete total, whether additional matches exist in hasMore, and whether the backend returned a partial result. Items contain a stable string key, a ranking score, and entity data used by the configured display and open templates.