Runs

List Pipeline Runs

get

Get pipeline runs according to query filters.

Args: pipeline_run_filter_model: Filter model used for pagination, sorting, filtering hydrate: Flag deciding whether to hydrate the output model(s) by including metadata fields in the response.

Returns: The pipeline runs according to query filters.

Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
pipeline_idany ofRequired
string · uuidOptional
or
stringOptional
or
nullOptional
Query parameters
hydratebooleanOptionalDefault: false
sort_bystringOptionalDefault: created
logical_operatorstring · enumOptional

Logical Ops to use to combine filters on list methods.

Default: andPossible values:
pageinteger · min: 1OptionalDefault: 1
sizeinteger · min: 1 · max: 10000OptionalDefault: 20
idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
createdany ofOptional
string · date-timeOptional
or
stringOptional
or
nullOptional
updatedany ofOptional
string · date-timeOptional
or
stringOptional
or
nullOptional
run_metadataany ofOptional
string[]Optional
or
nullOptional
tagany ofOptional
stringOptional
or
nullOptional
tagsany ofOptional
string[]Optional
or
nullOptional
scope_userany ofOptional
string · uuidOptional
or
nullOptional
userany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
projectany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
nameany ofOptional
stringOptional
or
nullOptional
orchestrator_run_idany ofOptional
stringOptional
or
nullOptional
stack_idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
schedule_idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
build_idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
snapshot_idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
code_repository_idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
template_idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
source_snapshot_idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
model_version_idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
linked_to_model_version_idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
statusany ofOptional
stringOptional
or
nullOptional
in_progressany ofOptional
booleanOptional
or
nullOptional
start_timeany ofOptional
string · date-timeOptional
or
stringOptional
or
nullOptional
end_timeany ofOptional
string · date-timeOptional
or
stringOptional
or
nullOptional
unlistedany ofOptional
booleanOptional
or
nullOptional
pipeline_nameany ofOptional
stringOptional
or
nullOptional
pipelineany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
stackany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
code_repositoryany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
modelany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
stack_componentany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
templatableany ofOptional
booleanOptional
or
nullOptional
triggered_by_step_run_idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
triggered_by_deployment_idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
get
/api/v1/pipelines/{pipeline_id}/runs
GET /api/v1/pipelines/{pipeline_id}/runs HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
  "index": 1,
  "max_size": 1,
  "total_pages": 1,
  "total": 1,
  "items": [
    {
      "body": {
        "created": "2025-11-14T19:01:27.566Z",
        "updated": "2025-11-14T19:01:27.566Z",
        "user_id": "123e4567-e89b-12d3-a456-426614174000",
        "project_id": "123e4567-e89b-12d3-a456-426614174000",
        "status": "initializing",
        "in_progress": true,
        "status_reason": "text"
      },
      "metadata": {
        "run_metadata": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "config": {
          "enable_cache": true,
          "enable_artifact_metadata": true,
          "enable_artifact_visualization": true,
          "enable_step_logs": true,
          "environment": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "secrets": [
            "123e4567-e89b-12d3-a456-426614174000"
          ],
          "enable_pipeline_logs": true,
          "execution_mode": "continue_on_failure",
          "settings": {
            "ANY_ADDITIONAL_PROPERTY": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          },
          "tags": [
            "text"
          ],
          "extra": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "failure_hook_source": {
            "module": "text",
            "attribute": "text",
            "type": "user",
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "success_hook_source": {
            "module": "text",
            "attribute": "text",
            "type": "user",
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "init_hook_source": {
            "module": "text",
            "attribute": "text",
            "type": "user",
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "init_hook_kwargs": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "cleanup_hook_source": {
            "module": "text",
            "attribute": "text",
            "type": "user",
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "model": {
            "name": "text",
            "license": "text",
            "description": "text",
            "audience": "text",
            "use_cases": "text",
            "limitations": "text",
            "trade_offs": "text",
            "ethics": "text",
            "tags": [
              "text"
            ],
            "version": "none",
            "save_models_to_registry": true,
            "model_version_id": "123e4567-e89b-12d3-a456-426614174000",
            "suppress_class_validation_warnings": false
          },
          "parameters": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "retry": {
            "max_retries": 1,
            "delay": 0,
            "backoff": 0
          },
          "substitutions": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "cache_policy": {
            "include_step_code": true,
            "include_step_parameters": true,
            "include_artifact_values": true,
            "include_artifact_ids": true,
            "ignored_inputs": [
              "text"
            ],
            "file_dependencies": [
              "text"
            ],
            "source_dependencies": [
              {
                "module": "text",
                "attribute": "text",
                "type": "user",
                "ANY_ADDITIONAL_PROPERTY": "anything"
              }
            ],
            "cache_func": {
              "module": "text",
              "attribute": "text",
              "type": "user",
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "expires_after": 1
          },
          "name": "text"
        },
        "start_time": "2025-11-14T19:01:27.566Z",
        "end_time": "2025-11-14T19:01:27.566Z",
        "client_environment": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "orchestrator_environment": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "orchestrator_run_id": "text",
        "code_path": "text",
        "is_templatable": false,
        "trigger_info": {
          "step_run_id": "123e4567-e89b-12d3-a456-426614174000",
          "deployment_id": "123e4567-e89b-12d3-a456-426614174000"
        }
      },
      "resources": {
        "user": {
          "body": {
            "created": "2025-11-14T19:01:27.566Z",
            "updated": "2025-11-14T19:01:27.566Z",
            "active": false,
            "activation_token": "text",
            "full_name": "",
            "email_opted_in": true,
            "is_service_account": true,
            "is_admin": true,
            "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
            "avatar_url": "text"
          },
          "metadata": {
            "email": "",
            "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
            "user_metadata": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          },
          "resources": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "permission_denied": false,
          "name": "text"
        },
        "snapshot": "[Circular Reference]",
        "source_snapshot": "[Circular Reference]",
        "stack": {
          "body": {
            "created": "2025-11-14T19:01:27.566Z",
            "updated": "2025-11-14T19:01:27.566Z",
            "user_id": "123e4567-e89b-12d3-a456-426614174000"
          },
          "metadata": {
            "components": {
              "ANY_ADDITIONAL_PROPERTY": [
                {
                  "body": {
                    "created": "2025-11-14T19:01:27.566Z",
                    "updated": "2025-11-14T19:01:27.566Z",
                    "user_id": "123e4567-e89b-12d3-a456-426614174000",
                    "type": "alerter",
                    "flavor_name": "text",
                    "integration": "text",
                    "logo_url": "text"
                  },
                  "metadata": {
                    "configuration": {
                      "ANY_ADDITIONAL_PROPERTY": "anything"
                    },
                    "environment": {
                      "ANY_ADDITIONAL_PROPERTY": "text"
                    },
                    "secrets": [
                      "123e4567-e89b-12d3-a456-426614174000"
                    ],
                    "labels": {
                      "ANY_ADDITIONAL_PROPERTY": "anything"
                    },
                    "connector_resource_id": "text",
                    "connector": {
                      "body": {
                        "created": "2025-11-14T19:01:27.566Z",
                        "updated": "2025-11-14T19:01:27.566Z",
                        "user_id": "123e4567-e89b-12d3-a456-426614174000",
                        "description": "",
                        "connector_type": "text",
                        "auth_method": "text",
                        "resource_types": [
                          "text"
                        ],
                        "resource_id": "text",
                        "supports_instances": false,
                        "expires_at": "2025-11-14T19:01:27.566Z",
                        "expires_skew_tolerance": 1
                      },
                      "metadata": {
                        "configuration": {
                          "ANY_ADDITIONAL_PROPERTY": "anything"
                        },
                        "expiration_seconds": 1,
                        "labels": {
                          "ANY_ADDITIONAL_PROPERTY": "text"
                        }
                      },
                      "resources": {
                        "user": {
                          "body": {
                            "created": "2025-11-14T19:01:27.566Z",
                            "updated": "2025-11-14T19:01:27.566Z",
                            "active": false,
                            "activation_token": "text",
                            "full_name": "",
                            "email_opted_in": true,
                            "is_service_account": true,
                            "is_admin": true,
                            "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
                            "avatar_url": "text"
                          },
                          "metadata": {
                            "email": "",
                            "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
                            "user_metadata": {
                              "ANY_ADDITIONAL_PROPERTY": "anything"
                            }
                          },
                          "resources": {
                            "ANY_ADDITIONAL_PROPERTY": "anything"
                          },
                          "id": "123e4567-e89b-12d3-a456-426614174000",
                          "permission_denied": false,
                          "name": "text"
                        },
                        "ANY_ADDITIONAL_PROPERTY": "anything"
                      },
                      "id": "123e4567-e89b-12d3-a456-426614174000",
                      "permission_denied": false,
                      "name": "text"
                    }
                  },
                  "resources": {
                    "user": {
                      "body": {
                        "created": "2025-11-14T19:01:27.566Z",
                        "updated": "2025-11-14T19:01:27.566Z",
                        "active": false,
                        "activation_token": "text",
                        "full_name": "",
                        "email_opted_in": true,
                        "is_service_account": true,
                        "is_admin": true,
                        "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
                        "avatar_url": "text"
                      },
                      "metadata": {
                        "email": "",
                        "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
                        "user_metadata": {
                          "ANY_ADDITIONAL_PROPERTY": "anything"
                        }
                      },
                      "resources": {
                        "ANY_ADDITIONAL_PROPERTY": "anything"
                      },
                      "id": "123e4567-e89b-12d3-a456-426614174000",
                      "permission_denied": false,
                      "name": "text"
                    },
                    "flavor": {
                      "body": {
                        "created": "2025-11-14T19:01:27.566Z",
                        "updated": "2025-11-14T19:01:27.566Z",
                        "user_id": "123e4567-e89b-12d3-a456-426614174000",
                        "type": "alerter",
                        "integration": "text",
                        "source": "text",
                        "logo_url": "text",
                        "is_custom": true
                      },
                      "metadata": {
                        "config_schema": {
                          "ANY_ADDITIONAL_PROPERTY": "anything"
                        },
                        "connector_type": "text",
                        "connector_resource_type": "text",
                        "connector_resource_id_attr": "text",
                        "docs_url": "text",
                        "sdk_docs_url": "text"
                      },
                      "resources": {
                        "user": {
                          "body": {
                            "created": "2025-11-14T19:01:27.566Z",
                            "updated": "2025-11-14T19:01:27.566Z",
                            "active": false,
                            "activation_token": "text",
                            "full_name": "",
                            "email_opted_in": true,
                            "is_service_account": true,
                            "is_admin": true,
                            "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
                            "avatar_url": "text"
                          },
                          "metadata": {
                            "email": "",
                            "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
                            "user_metadata": {
                              "ANY_ADDITIONAL_PROPERTY": "anything"
                            }
                          },
                          "resources": {
                            "ANY_ADDITIONAL_PROPERTY": "anything"
                          },
                          "id": "123e4567-e89b-12d3-a456-426614174000",
                          "permission_denied": false,
                          "name": "text"
                        },
                        "ANY_ADDITIONAL_PROPERTY": "anything"
                      },
                      "id": "123e4567-e89b-12d3-a456-426614174000",
                      "permission_denied": false,
                      "name": "text"
                    },
                    "ANY_ADDITIONAL_PROPERTY": "anything"
                  },
                  "id": "123e4567-e89b-12d3-a456-426614174000",
                  "permission_denied": false,
                  "name": "text"
                }
              ]
            },
            "description": "",
            "stack_spec_path": "text",
            "environment": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "secrets": [
              "123e4567-e89b-12d3-a456-426614174000"
            ],
            "labels": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          },
          "resources": {
            "user": {
              "body": {
                "created": "2025-11-14T19:01:27.566Z",
                "updated": "2025-11-14T19:01:27.566Z",
                "active": false,
                "activation_token": "text",
                "full_name": "",
                "email_opted_in": true,
                "is_service_account": true,
                "is_admin": true,
                "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
                "avatar_url": "text"
              },
              "metadata": {
                "email": "",
                "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
                "user_metadata": {
                  "ANY_ADDITIONAL_PROPERTY": "anything"
                }
              },
              "resources": {
                "ANY_ADDITIONAL_PROPERTY": "anything"
              },
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "permission_denied": false,
              "name": "text"
            },
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "permission_denied": false,
          "name": "text"
        },
        "pipeline": "[Circular Reference]",
        "build": "[Circular Reference]",
        "schedule": {
          "body": {
            "created": "2025-11-14T19:01:27.566Z",
            "updated": "2025-11-14T19:01:27.566Z",
            "user_id": "123e4567-e89b-12d3-a456-426614174000",
            "project_id": "123e4567-e89b-12d3-a456-426614174000",
            "active": true,
            "cron_expression": "text",
            "start_time": "2025-11-14T19:01:27.566Z",
            "end_time": "2025-11-14T19:01:27.566Z",
            "interval_second": "text",
            "catchup": false,
            "run_once_start_time": "2025-11-14T19:01:27.566Z"
          },
          "metadata": {
            "orchestrator_id": "123e4567-e89b-12d3-a456-426614174000",
            "pipeline_id": "123e4567-e89b-12d3-a456-426614174000",
            "run_metadata": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            }
          },
          "resources": {
            "user": {
              "body": {
                "created": "2025-11-14T19:01:27.566Z",
                "updated": "2025-11-14T19:01:27.566Z",
                "active": false,
                "activation_token": "text",
                "full_name": "",
                "email_opted_in": true,
                "is_service_account": true,
                "is_admin": true,
                "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
                "avatar_url": "text"
              },
              "metadata": {
                "email": "",
                "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
                "user_metadata": {
                  "ANY_ADDITIONAL_PROPERTY": "anything"
                }
              },
              "resources": {
                "ANY_ADDITIONAL_PROPERTY": "anything"
              },
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "permission_denied": false,
              "name": "text"
            },
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "permission_denied": false,
          "name": "text"
        },
        "code_reference": {
          "body": {
            "created": "2025-11-14T19:01:27.566Z",
            "updated": "2025-11-14T19:01:27.566Z",
            "commit": "text",
            "subdirectory": "text",
            "code_repository": {
              "body": {
                "created": "2025-11-14T19:01:27.566Z",
                "updated": "2025-11-14T19:01:27.566Z",
                "user_id": "123e4567-e89b-12d3-a456-426614174000",
                "project_id": "123e4567-e89b-12d3-a456-426614174000",
                "source": {
                  "module": "text",
                  "attribute": "text",
                  "type": "user",
                  "ANY_ADDITIONAL_PROPERTY": "anything"
                },
                "logo_url": "text"
              },
              "metadata": {
                "config": {
                  "ANY_ADDITIONAL_PROPERTY": "anything"
                },
                "description": "text"
              },
              "resources": {
                "user": {
                  "body": {
                    "created": "2025-11-14T19:01:27.566Z",
                    "updated": "2025-11-14T19:01:27.566Z",
                    "active": false,
                    "activation_token": "text",
                    "full_name": "",
                    "email_opted_in": true,
                    "is_service_account": true,
                    "is_admin": true,
                    "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
                    "avatar_url": "text"
                  },
                  "metadata": {
                    "email": "",
                    "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
                    "user_metadata": {
                      "ANY_ADDITIONAL_PROPERTY": "anything"
                    }
                  },
                  "resources": {
                    "ANY_ADDITIONAL_PROPERTY": "anything"
                  },
                  "id": "123e4567-e89b-12d3-a456-426614174000",
                  "permission_denied": false,
                  "name": "text"
                },
                "ANY_ADDITIONAL_PROPERTY": "anything"
              },
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "permission_denied": false,
              "name": "text"
            }
          },
          "metadata": {},
          "resources": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "permission_denied": false
        },
        "trigger_execution": "[Circular Reference]",
        "model_version": "[Circular Reference]",
        "tags": [
          {
            "body": {
              "created": "2025-11-14T19:01:27.566Z",
              "updated": "2025-11-14T19:01:27.566Z",
              "user_id": "123e4567-e89b-12d3-a456-426614174000",
              "color": "grey",
              "exclusive": true
            },
            "metadata": {
              "tagged_count": 1
            },
            "resources": {
              "user": {
                "body": {
                  "created": "2025-11-14T19:01:27.566Z",
                  "updated": "2025-11-14T19:01:27.566Z",
                  "active": false,
                  "activation_token": "text",
                  "full_name": "",
                  "email_opted_in": true,
                  "is_service_account": true,
                  "is_admin": true,
                  "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
                  "avatar_url": "text"
                },
                "metadata": {
                  "email": "",
                  "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
                  "user_metadata": {
                    "ANY_ADDITIONAL_PROPERTY": "anything"
                  }
                },
                "resources": {
                  "ANY_ADDITIONAL_PROPERTY": "anything"
                },
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "permission_denied": false,
                "name": "text"
              },
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "permission_denied": false,
            "name": "text"
          }
        ],
        "logs": {
          "body": {
            "created": "2025-11-14T19:01:27.566Z",
            "updated": "2025-11-14T19:01:27.566Z",
            "uri": "text",
            "source": "text"
          },
          "metadata": {
            "step_run_id": "123e4567-e89b-12d3-a456-426614174000",
            "pipeline_run_id": "123e4567-e89b-12d3-a456-426614174000",
            "artifact_store_id": "123e4567-e89b-12d3-a456-426614174000"
          },
          "resources": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "permission_denied": false
        },
        "log_collection": [
          {
            "body": {
              "created": "2025-11-14T19:01:27.566Z",
              "updated": "2025-11-14T19:01:27.566Z",
              "uri": "text",
              "source": "text"
            },
            "metadata": {
              "step_run_id": "123e4567-e89b-12d3-a456-426614174000",
              "pipeline_run_id": "123e4567-e89b-12d3-a456-426614174000",
              "artifact_store_id": "123e4567-e89b-12d3-a456-426614174000"
            },
            "resources": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "permission_denied": false
          }
        ],
        "visualizations": [
          "[Circular Reference]"
        ],
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": false,
      "name": "text"
    }
  ]
}

Last updated

Was this helpful?