List schedules

Lists the caller's own schedules, oldest first, one page at a time. Archived schedules are left out: archiving is how a schedule leaves the working set, and a listing that still carried them would make the operation pointless. Give endpoint to keep the page to the schedules that deliver to that endpoint — the way back from a destination to everything pointed at it, which is what somebody who disabled or is about to move an endpoint needs to see. Items are schedules rather than schedules-with-occurrences, because a cross-partition listing is served from a projection that holds a summary; read a schedule to get its authoritative next occurrence. Every page states whether it is authoritative or projected.

get/v1/schedules

Request

  • Base URL: https://docs.greatwait.dev (the document declares no server; this is the origin it was published from)
  • URL: https://docs.greatwait.dev/v1/schedules
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer and API key in header Greatwait-Environment and API key in header Greatwait-Project

Query parameters

cursorstring
dueAfterstring
dueBeforestring
string
OR
'none'
external_identifierstring

Host application identifier, matched exactly and case-sensitively; at most 256 UTF-8 bytes. Readable by schedule readers; do not include secrets.

limitinteger
order'created' | 'due'
recurrence'at' | 'every' | 'cron'
schedulestring
status'active' | 'paused' | 'cancelled' | 'completed'
tagstring

An exact, case-sensitive tag of at most 64 UTF-8 bytes.

textstring

Case-insensitive literal substring of schedule name, endpoint address or schedule identifier.

Response

List schedules

nextCursorstring

Changes

No recorded changes to this operation across all 1 revision of this API.