Skip to main content
GET
List Schedules

Query Parameters

per_page
integer
default:15

How many items to show per page.

page
integer

Which page to show.

filter[meta]
string
sort
enum<string>[]
Available options:
name,
-name,
id,
-id,
scheduled_at,
-scheduled_at,
completed_at,
-completed_at
filter[name]
string

Filter the resources by name.

filter[status]
enum<integer>

Filter the resources by status.

Available options:
0,
1,
2
include
enum<string>[]

Include related data (components, components.group, updates, user, meta).

Available options:
components,
componentsCount,
componentsExists,
components.group,
updates,
updatesCount,
updatesExists,
user,
userCount,
userExists,
meta,
metaCount,
metaExists

Response

200 - application/vnd.api+json

Paginated set of Schedule

data
Schedule · object[]
required
meta
object
required
included
(Component · object | Update · object)[]