Sign in
latestOpenAPI 3.1.02026-08-142887561.0 MB

61436a496404

workflows.deployments

List Deployments

List Deployments

get/v1/workflows/deployments

Query parameters

active_onlyboolean
is_hardenedboolean nullable

Filter deployments by hardened status

Filter deployments by hardened status

workflow_namestring nullable
searchstring nullable

Filter deployments by name or ID prefix

Filter deployments by name or ID prefix

order_by'updated_at' | 'created_at' nullable

Field to sort by. When omitted, active and managed deployments are grouped first, then sorted by created_at. When set, results are sorted purely by the specified field with no grouping.

Field to sort by. When omitted, active and managed deployments are grouped first, then sorted by created_at. When set, results are sorted purely by the specified field with no grouping.

order'asc' | 'desc'

Sort direction. Applied to order_by when set, or within each activity group when omitted.

Sort direction. Applied to order_by when set, or within each activity group when omitted.

limitinteger nullable

Maximum number of deployments to return

Maximum number of deployments to return

cursorstring nullable

Cursor from a previous response for pagination

Cursor from a previous response for pagination

workspace_idstring uuid nullable

Workspace ID to scope the request to. Defaults to the caller's context.

Workspace ID to scope the request to. Defaults to the caller's context.

Response

Successful Response

next_cursorstring nullable required

Cursor for the next page of results

workspace_idstring uuid required

Workspace ID the results are scoped to