Skip to main content

diagrid workflow list

List workflow executions for all App IDs in a project

Description​

List workflow executions for all App IDs in a project

diagrid workflow list [flags]

Examples​


  # List workflow executions for all App IDs in a project
  diagrid workflow list

  # List a maximum of 250 workflow executions
  diagrid workflow list --limit 250

  # List by execution status
  diagrid workflow list --status failed,cancelled

  # List by App ID
  diagrid workflow list --app-id orders --app-id payments

  # List by workflow name
  diagrid workflow list --name OrderWorkflow,ShippingWorkflow

  # List by end time
  diagrid workflow list --end-before "2026-05-20T19:30:00+02:00"

  # Sort by start time, newest first
  diagrid workflow list --sort-by startAt --order desc

  # Sort by workflow name, alphabetically
  diagrid workflow list --sort-by name

  # Filter by custom status fields (key=value pairs)
  diagrid workflow list --custom-status region=us-east,tier=gold

Options​

  -p, --project string                 Name of existing project
  -o, --output string                  Output format, supported [table, yaml, json] (default "table")
  -l, --limit int                      The maximum number of workflows to return. The value cannot be greater than 250 (default 250)
  -s, --status strings                 Filter workflows by execution status. Can be repeated to pass multiple values.
                                       Valid values:canceled, completed, failed, running, suspended, terminated
  -a, --app-id strings                 Filter workflows by App ID. Can be repeated to pass multiple values.
  -n, --name strings                   Filter workflows by workflow name. Can be repeated to pass multiple values.
      --sort-by string                 Sort workflows by the given field. Valid values: name, createdAt, startAt, endAt, status, appId.
      --custom-status stringToString   Filter workflows by custom status fields as key=value pairs. Can be repeated to pass multiple values. (default [])
      --order string                   Sort order when --sort-by is set. Valid values: asc, desc. (default "desc")
      --start-after time               Return workflows that started after the given time in RFC3339 format (e.g 2006-01-02T15:04:05Z07:00))
      --start-before time              Return workflows that started before the given time in RFC3339 format (e.g 2006-01-02T15:04:05Z07:00))
      --end-after time                 Return workflows that ended after the given time in RFC3339 format (e.g 2006-01-02T15:04:05Z07:00))
      --end-before time                Return workflows that ended before the given time in RFC3339 format (e.g 2006-01-02T15:04:05Z07:00))
  -h, --help                           help for list

Options inherited from parent commands​

      --api-key string   Diagrid Cloud API key

SEE ALSO​

Last updated on