Workflows

Query Workflows

Changed on

Query workflow artifacts with filters and pagination.

Accepts the same filters as query parameters or in the request body; body fields win when both are supplied. Results are ordered by creation time; pass windowing.next back for the following page.

See: Query Pattern.

post/workflows/query

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/workflows/query
  • Auth
    API key in header Authorization

Query parameters

workflow_idstring uuid nullable
workflow_idsstring[] nullable
workflow_slugstring nullable
workflow_slugsstring[] nullable
namestring nullable
descriptionstring nullable
flagsstring nullable
tagsstring nullable
metastring nullable
include_archivedboolean nullable
nextstring uuid nullable
neweststring date-time nullable
oldeststring date-time nullable
limitinteger nullable
order'ascending' | 'descending' nullable

Response

Successful Response

countinteger

Number of workflows in this page.

Changes

  • a7f9a6823230Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

  • d7e21f629c88Revision changes
    • info

      the response's property default value was removed for the status