workflow-schedules

List workflow schedules.

Changed on

Lists paginated workflow schedules for a workflow definition.

get/api/workflow/{agentName}/{workflowName}/schedule

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/workflow/{agentName}/{workflowName}/schedule
  • Auth: HTTP bearer

Path parameters

agentNamestring required

Agent name.

workflowNamestring required

Workflow name scoped to an agent.

Query parameters

limitinteger

Maximum number of items to return.

page_tokenstring

Opaque pagination token from a previous response.

sort_by'name' | 'workflow_name' | 'schedule' | 'created_at'

Workflow schedule field used to order results before pagination.

sort_order'asc' | 'desc'

Sort direction. Defaults to ascending when sort_by is set.

Response

Paginated workflow schedules for a workflow.

next_page_tokenstring required

Changes