Search
List Search Query 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.
get/search/query/schema
Request
- Base URLhttps://console.jumpcloud.com/api/v2
- AuthAPI key in header x-api-key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
excludeIntermediateboolean
When true, omit schema objects marked intermediate (mapping/join tables).
Response
A successful response.
Changes
No recorded changes to this operation across all 1 revision of this API.