--- title: "List Builds" method: GET path: "/api/v1/pipeline_builds" tags: ["builds"] --- # List Builds `GET /api/v1/pipeline_builds` Gets a list of builds. Args: build_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: List of build objects. ## Query parameters - `hydrate` boolean - `sort_by` string - `logical_operator` 'or' | 'and' — Logical Ops to use to combine filters on list methods. - `page` integer - `size` integer - `id` union - string, uuid - string - `created` union - string, date-time - string - `updated` union - string, date-time - string - `scope_workspace` string, uuid, nullable - `workspace_id` union - string, uuid - string - `user_id` union - string, uuid - string - `pipeline_id` union - string, uuid - string - `stack_id` union - string, uuid - string - `is_local` boolean, nullable - `contains_code` boolean, nullable - `zenml_version` string, nullable - `python_version` string, nullable - `checksum` string, nullable ## Response `200` Successful Response - PagePipelineBuildResponse - `index` integer, required - `max_size` integer, required - `total_pages` integer, required - `total` integer, required - `items` PipelineBuildResponse[], required - `body` PipelineBuildResponseBody — Response body for pipeline builds. - `created` string, date-time, required - `updated` string, date-time, required - `user` UserResponse — Response model for user and service accounts. This returns the activation_token that is required for the user-invitation-flow of the frontend. The email is returned optionally as well for use by the analytics on the client-side. - `body` UserResponseBody — Response body for users. - `created` string, date-time, required - `updated` string, date-time, required - `active` boolean - `activation_token` string, nullable - `full_name` string - `email_opted_in` boolean, nullable — `null` if not answered, `true` if agreed, `false` if skipped. - `is_service_account` boolean, required - `is_admin` boolean, required - `metadata` UserResponseMetadata — Response metadata for users. - `email` string, nullable - `external_user_id` string, uuid, nullable - `user_metadata` object - `resources` UserResponseResources — Class for all resource models associated with the user entity. - `id` string, uuid, required - `permission_denied` boolean - `name` string, required - `metadata` PipelineBuildResponseMetadata — Response metadata for pipeline builds. - `workspace` WorkspaceResponse, required — Response model for workspaces. - `body` WorkspaceResponseBody — Response body for workspaces. - `created` string, date-time, required - `updated` string, date-time, required - `metadata` WorkspaceResponseMetadata — Response metadata for workspaces. - `description` string - `resources` WorkspaceResponseResources — Class for all resource models associated with the workspace entity. - `id` string, uuid, required - `permission_denied` boolean - `name` string, required - `pipeline` PipelineResponse — Response model for pipelines. - `body` PipelineResponseBody — Response body for pipelines. - `created` string, date-time, required - `updated` string, date-time, required - `user` UserResponse — Response model for user and service accounts. This returns the activation_token that is required for the user-invitation-flow of the frontend. The email is returned optionally as well for use by the analytics on the client-side. - `body` UserResponseBody — Response body for users. - … - `metadata` UserResponseMetadata — Response metadata for users. - … - `resources` UserResponseResources — Class for all resource models associated with the user entity. - `id` string, uuid, required - `permission_denied` boolean - `name` string, required - `latest_run_id` string, uuid, nullable - `latest_run_status` 'initializing' | 'failed' | 'completed' | 'running' | 'cached' — Enum that represents the current status of a step or pipeline run. - `metadata` PipelineResponseMetadata — Response metadata for pipelines. - `workspace` WorkspaceResponse, required — Response model for workspaces. - `body` WorkspaceResponseBody — Response body for workspaces. - … - `metadata` WorkspaceResponseMetadata — Response metadata for workspaces. - … - `resources` WorkspaceResponseResources — Class for all resource models associated with the workspace entity. - `id` string, uuid, required - `permission_denied` boolean - `name` string, required - `description` string, nullable - `resources` PipelineResponseResources — Class for all resource models associated with the pipeline entity. - `tags` TagResponse[], required - `body` TagResponseBody — Response body for tags. - … - `metadata` BaseResponseMetadata — Base metadata model. Used as a base class for all metadata models associated with responses. - `resources` TagResponseResources — Class for all resource models associated with the tag entity. - `id` string, uuid, required - `permission_denied` boolean - `name` string, required — The unique title of the tag. - `id` string, uuid, required - `permission_denied` boolean - `name` string, required - `stack` StackResponse — Response model for stacks. - `body` StackResponseBody — Response body for stacks. - `created` string, date-time, required - `updated` string, date-time, required - `user` UserResponse — Response model for user and service accounts. This returns the activation_token that is required for the user-invitation-flow of the frontend. The email is returned optionally as well for use by the analytics on the client-side. - `body` UserResponseBody — Response body for users. - … - `metadata` UserResponseMetadata — Response metadata for users. - … - `resources` UserResponseResources — Class for all resource models associated with the user entity. - `id` string, uuid, required - `permission_denied` boolean - `name` string, required - `metadata` StackResponseMetadata — Response metadata for stacks. - `workspace` WorkspaceResponse, required — Response model for workspaces. - `body` WorkspaceResponseBody — Response body for workspaces. - … - `metadata` WorkspaceResponseMetadata — Response metadata for workspaces. - … - `resources` WorkspaceResponseResources — Class for all resource models associated with the workspace entity. - `id` string, uuid, required - `permission_denied` boolean - `name` string, required - `components` object, required - `description` string, nullable - `stack_spec_path` string, nullable - `labels` object, nullable - `resources` StackResponseResources — Class for all resource models associated with the stack entity. - `id` string, uuid, required - `permission_denied` boolean - `name` string, required - `images` object - `zenml_version` string, nullable - `python_version` string, nullable - `checksum` string, nullable - `stack_checksum` string, nullable - `is_local` boolean, required - `contains_code` boolean, required - `resources` PipelineBuildResponseResources — Class for all resource models associated with the pipeline build entity. - `id` string, uuid, required - `permission_denied` boolean ## Other responses - `401` — Unauthorized - `403` — Forbidden - `404` — Not Found - `422` — Unprocessable Entity --- [API](https://skmtc.net/zenml-io/apis/zenml-2.md) · [All operations](https://skmtc.net/zenml-io/apis/zenml-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/zenml-io/zenml-2/versions/febb01b8bce3/schema)