Sign in
workflow
public

Get Workflows

Retrieve a list of workflows.

Parameters:

  • project_id (str, optional): Project ID to filter workflows. If not provided, all workflows for the customer will be retrieved.

Returns:

  • dict: A response containing the list of workflows.
get/v1/workflows

Query parameters

project_idstring

Project ID to filter workflows

Project ID to filter workflows

limitinteger
offsetinteger
order_by'updated_at' | 'created_at' | 'id'

An enumeration.

order'asc' | 'desc'

An enumeration.

Headers

API-Versionstring

Pass in an API version to guarantee a consistent response format.

The latest version should be used for all new API calls. Existing API calls should be updated to the latest version when possible.

Valid versions:

  • Latest API version (recommended): 2025-03

  • Previous API version (maintenance mode): 2025-02

If no API version header is included, the response format is considered unstable and could change without notice (not recommended).

Pass in an API version to guarantee a consistent response format.

The latest version should be used for all new API calls. Existing API calls should be updated to the latest version when possible.

Valid versions:

  • Latest API version (recommended): 2025-03

  • Previous API version (maintenance mode): 2025-02

If no API version header is included, the response format is considered unstable and could change without notice (not recommended).

Response

Successful Response

messagestring required

Changes

No recorded changes to this endpoint across all 1 revision of this API.