---
title: "Get Search Query Schema By ObjectName"
method: GET
path: "/api/v2/search/query/schema/{objectName}"
tags: ["Search"]
---

# Get Search Query Schema By ObjectName

`GET /api/v2/search/query/schema/{objectName}`

## Request

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

Returns the Search schema for a single object. Use this when you already know the object (for example user or device) and only need that object’s fields and join targets. Response shape matches List Schema, but objects typically contain a single entry.

**When to use**
Use cases such as loading field metadata for one entity in a UI, or validating filters and fields for a specific object.

**When not to use**
Discovering all available objects — use GET /api/v2/search/query/schema instead.

## Path parameters

- `objectName` string, required

## 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
- `404`: Not Found
- `500`: Internal Server Error

---

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