Reports
List Scheduled Reports
List Scheduled Reports.
Sample Request
curl -X GET https://console.jumpcloud.com/api/v2/reports/scheduled \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
get/api/v2/reports/scheduled
Request
- Base URLhttps://console.jumpcloud.com
- AuthAPI key in header x-api-key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
limitstring int64
The number of records to return at once. Limited to 100.
skipstring int64
The offset into the records to return.
sortstring
Use space separated sort parameters to sort the collection. Default sort is ascending. Prefix with - to sort descending.
fieldsstring[]
The fields on the items listed to return.
filterstring[]
A filter to apply to the query.
**Filter structure**: `<field>:<operator>:<value>`.
**field** = Use camelCase only; allowed values: displayName, description, scheduleFrequency, isActive, createdAt, updatedAt. Do not use snake_case (e.g. display_name is invalid).
**operator** = Supported operators: eq, ne, gt, ge, lt, le, search, in.
**value** = Value to search for (case sensitive; supports wild cards).
**Example** `GET /api/v2/reports/scheduled?filter=displayName:eq:Daily+Report`
Response
Success listing Scheduled Reports.
Changes
No recorded changes to this operation across all 1 revision of this API.