MImistral
workflows.schedules

Get Schedules

Changed on

Get Schedules

get/v1/workflows/schedules

Request

Query parameters

workflow_namestring nullable

Filter by exact workflow name

user_idstring nullable

Filter by user ID. Pass 'current' to resolve to the authenticated user's ID.

status'active' | 'paused' nullable

Filter by schedule status: 'active' or 'paused'

searchstring nullable

Prefix search query for workflow name

page_sizeinteger nullable

Number of items per page. Omitting this parameter fetches all results at once (deprecated — pass page_size to use pagination).

next_page_tokenstring nullable

Token for the next page of results

Response

Successful Response

next_page_tokenstring nullable

Token for the next page of results

Changes

  • 61436a496404Revision changes
    • info

      added the new optional query request parameter search

  • 5a5c361558bbRevision changes
    • info

      api tag workflows.schedules added

    • info

      api tag beta.workflows.schedules removed

    • info

      added the new optional query request parameter next_page_token

    • info

      added the new optional query request parameter page_size

    • info

      added the new optional query request parameter status

    • info

      added the new optional query request parameter user_id

    • info

      added the new optional query request parameter workflow_name

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status