Search
Get Search Query Schema By ObjectName
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.
get/search/query/schema/{objectName}
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.
Path parameters
objectNamestring required
Object to scope schema return for
Response
A successful response.
Changes
No recorded changes to this operation across all 1 revision of this API.