Skip to main content

List workflows​

Retrieve a list of workflows for the organization

Query Parameters
  • status string

    Possible values: [draft, active, paused, deleted]

    Filter by workflow status

  • limit integer

    Possible values: >= 1 and <= 100

    Default value: 50

    Maximum number of workflows to return

  • offset integer

    Offset for pagination

Header Parameters
  • SlashID-OrgID string required

    The organization ID

    Example: af5fbd30-7ce7-4548-8b30-4cd59cb2aba1
Responses

List of workflows

Schema
  • meta object
  • pagination object
  • limit integer
  • offset integer
  • total_count int64
  • errors object[]
  • httpcode integer
  • message string
  • result object
  • workflows object[]
  • id string

    Unique workflow identifier

  • org_id string

    Organization ID

  • name string

    Possible values: non-empty and <= 255 characters

    Workflow name

  • description string

    Possible values: <= 1000 characters

    Workflow description

  • status string

    Possible values: [draft, active, paused, deleted]

    Current state of a workflow

  • created_by string

    User ID who created the workflow

  • created_at date-time

    Workflow creation timestamp

  • updated_by string

    User ID who last updated the workflow

  • updated_at date-time

    Last update timestamp

  • activated_at date-time

    When workflow was first activated

  • paused_at date-time

    When workflow was paused

  • last_executed_at date-time

    Last execution timestamp

  • execution_count integer

    Total execution count

  • success_count integer

    Successful execution count

  • failure_count integer

    Failed execution count

  • latest_configuration_id string

    ID of the latest configuration version

  • latest_configuration_version integer

    Latest configuration version number