---
title: "List Search Query Schema"
method: GET
path: "/search/query/schema"
tags: ["Search"]
---

# List Search Query Schema

`GET /search/query/schema`

## Request

- Base URL: `https://console.jumpcloud.com/api/v2`
- URL: `https://console.jumpcloud.com/api/v2/search/query/schema`
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/jumpcloud/apis/jumpcloud-api-2/docs/search/query/schema/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns the full Search schema visible to the caller: searchable objects, their fields, joinable related objects, and field capabilities (filter, sort, and aggregate). Use this to drive query builders, validate Dynamic Group rules, and discover report columns.

**When to use**
Use cases such as populating field pickers, validating query builders, or documenting the attributes available for reporting.

**When not to use**
Retrieving actual data rows — use POST /api/v2/search/query for that.

## Query parameters

- `excludeIntermediate` boolean

## Response `200`

A successful response.

- JumpcloudSearchSchemaResponse
  - `objects` JumpcloudSearchSchemaObject[]
    - `description` string
    - `fields` JumpcloudSearchSchemaObjectField[]
      - `aggregatable` boolean
      - `allowedUnits` string[]
      - `description` string
      - `filterable` boolean
      - `format` string, nullable
      - `label` string
      - `name` string: Name of the field. This will be in the normal <objectName>.<fieldName> format.
      - `popularity` number, float
      - `sortable` boolean
      - `type` 'type_unknown' | 'datetime' | 'boolean' | 'string' | 'number' | 'array': The type of the field. This is a enum that can be used as a hint to the underlying value's type. number: An integer or floating point number boolean: Either 'true' or 'false' datetime: An ISO 8601 date time. No offset will be provided, and can be assumed to be UTC. Ex. '2024-09-11T23:05:23Z' string: General text. array: A list of string values (e.g. PostgreSQL text[] or comma-separated string).
      - `valueset` string[]: Optional. When set, can be used as a guide for the UI to allow for a low cardinality set of values to be displayed as options.
    - `joins` string[]: Note that this is actually just a list of objects that can be joined with this object in total. It includes objects relations from both the metadata `joins`, and the metadata `associations` fields.
    - `label` string
    - `name` string
    - `objectType` string: Optional. Object category hint for clients (e.g. "event").
    - `timestampField` string: Optional. Unqualified field name for default time filtering (e.g. "event_timestamp").

## Other responses

- `401`: Unauthorized

---

[API](https://skmtc.dev/jumpcloud/apis/jumpcloud-api-2.md) - [All operations](https://skmtc.dev/jumpcloud/apis/jumpcloud-api-2/llms.txt) - [OpenAPI document](https://skmtc.dev/jumpcloud/apis/jumpcloud-api-2/revisions/3f09fe63caaa?raw)