Workflows

Query Workflow Variants

Changed on

Query workflow variants with filters and pagination.

Scope the query by workflow_refs (parent artifact) or workflow_variant_refs (specific variants). Accepts the same fields as query parameters or in the request body.

See: Query Pattern.

post/workflows/variants/query

Request

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

Query parameters

workflow_idstring uuid nullable
workflow_idsstring[] nullable
workflow_slugstring nullable
workflow_slugsstring[] nullable
workflow_variant_idstring uuid nullable
workflow_variant_idsstring[] nullable
workflow_variant_slugstring nullable
workflow_variant_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 variants in this page.

Changes

  • 2040366204e5Revision changes
    • info

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

    • info

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

  • 67e2a3c6952dRevision changes
    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status