Search
Run Search Query
Query your JumpCloud data such as users, user groups, devices, and related objects using a structured JSON filter DSL. Use this endpoint to select fields, apply nested filters, sort and paginate results, and optionally aggregate data.
When to use Building reports, dashboards, exports, or integrations that need filtered, join-aware queries over your JumpCloud data such as users, user groups, devices, and related objects.
When not to use Free-text / keyword search across many fields at once.
post/search/query
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.
Headers
x-org-idstring
Organization identifier that can be obtained from console settings.
Request body
Response
A successful response.
Changes
No recorded changes to this operation across all 1 revision of this API.