Sign in
Schedules

List schedules

Returns schedules with the full taskTemplate replaced by a short taskTemplatePreview by default — list views never render the full template. Pass fields=full to restore taskTemplate. Fetch the full template via GET /api/schedules/{id}.

get/api/schedules

Query parameters

enabled'true' | 'false'
namestring
scheduleType'recurring' | 'one_time'
targetType'agent-task' | 'workflow' | 'script'
workflowIdstring uuid
scriptNamestring
hideCompleted'true' | 'false'
consecutiveErrorsMininteger nullable
lastRunStatus'failed' | 'succeeded'
fields'full' | 'slim'
keystring

Non-unique asset directory namespace (for example shared/ or personal/<user-id>/drafts/). Runtime write boundaries normalize and validate the canonical form.

Non-unique asset directory namespace (for example shared/ or personal/<user-id>/drafts/). Runtime write boundaries normalize and validate the canonical form.

keyPrefixstring

Non-unique asset directory namespace (for example shared/ or personal/<user-id>/drafts/). Runtime write boundaries normalize and validate the canonical form.

Non-unique asset directory namespace (for example shared/ or personal/<user-id>/drafts/). Runtime write boundaries normalize and validate the canonical form.

Response

List of schedules

countinteger required

Changes

Changed in 4 of the 104 revisions of this API.45

  • 06cac6a7c5bc1See the full diff
    • ○

      added the media type application/json for the response with the status

      response-media-type-added

  • f1022d5edb0d2See the full diff
    • ○

      added the new optional query request parameter key

      new-optional-request-parameter

    • ○

      added the new optional query request parameter keyPrefix

      new-optional-request-parameter

  • 13bd92bf5f042See the full diff
    • ○

      added the new optional query request parameter consecutiveErrorsMin

      new-optional-request-parameter

    • ○

      added the new optional query request parameter lastRunStatus

      new-optional-request-parameter

  • 0c910612f9ac4See the full diff
    • ●

      deleted the query request parameter consecutiveErrorsMin

      request-parameter-removed

    • ●

      deleted the query request parameter key

      request-parameter-removed

    • ●

      deleted the query request parameter keyPrefix

      request-parameter-removed

    • ●

      deleted the query request parameter lastRunStatus

      request-parameter-removed