List schedules

schedules(projectReference: String!, input: SchedulesInput): ScheduleList!

Requires project.runs.read.

Arguments

ArgumentTypeRequired
projectReferenceString!Yes
inputSchedulesInputNo

Input fields

input

SchedulesInput

FieldTypeRequiredDescription
statusScheduleStatusNo
sourceTriggerIdStringNoOnly the schedule activated from this source schedule.
sortByScheduleSortByNoDefault created_at; ties break by id ascending.
sortOrderScheduleSortOrderNoDefault desc.
limitIntNoMaximum schedules per page, 1 to 200; default 100.
cursorIDNoThe previous page's pageInfo.endCursor. Keep the other fields the same across pages.

Response

Returns ScheduleList!. Open the type for its fields and nested types.

FieldType
data[Schedule!]!
pageInfoPageInfo!

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

graphql
query Schedules($projectReference: String!, $input: SchedulesInput) {
  schedules(projectReference: $projectReference, input: $input) {
    data {
      id
      projectId
      name
      status
      createdAt
    }
    pageInfo {
      hasNextPage
      endCursor
      hasPreviousPage
      startCursor
    }
  }
}
json
{
  "projectReference": "example"
}