---
title: "List Artifact Versions"
method: GET
path: "/api/v1/artifact_versions"
tags: ["artifact_versions"]
---

# List Artifact Versions

`GET /api/v1/artifact_versions`

Get artifact versions according to query filters.

Args:
    artifact_version_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.
    auth_context: The authentication context.

Returns:
    The artifact versions according to query filters.

## 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
- `tag` string, nullable
- `artifact_id` union
  - string, uuid
  - string
- `name` string, nullable
- `version` string, nullable
- `version_number` union
  - integer
  - string
- `uri` string, nullable
- `materializer` string, nullable
- `type` string, nullable
- `data_type` string, nullable
- `artifact_store_id` union
  - string, uuid
  - string
- `workspace_id` union
  - string, uuid
  - string
- `user_id` union
  - string, uuid
  - string
- `only_unused` boolean, nullable
- `has_custom_name` boolean, nullable

## Response `200`

Successful Response

- PageArtifactVersionResponse
  - `index` integer, required
  - `max_size` integer, required
  - `total_pages` integer, required
  - `total` integer, required
  - `items` ArtifactVersionResponse[], required
    - `body` ArtifactVersionResponseBody — Response body for artifact versions.
      - `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
      - `artifact` ArtifactResponse, required — Artifact response model.
        - `body` ArtifactResponseBody — Response body for artifacts.
          - `created` string, date-time, required
          - `updated` string, date-time, required
          - `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.
          - `latest_version_name` string, nullable
          - `latest_version_id` string, uuid, nullable
        - `metadata` ArtifactResponseMetadata — Response metadata for artifacts.
          - `has_custom_name` boolean
        - `resources` ArtifactResponseResources — Class for all resource models associated with the Artifact Entity.
        - `id` string, uuid, required
        - `permission_denied` boolean
        - `name` string, required
      - `version` string, required
      - `uri` string, required
      - `type` 'DataAnalysisArtifact' | 'DataArtifact' | 'ModelArtifact' | 'SchemaArtifact' | 'ServiceArtifact' | 'StatisticsArtifact' | 'BaseArtifact', required — All possible types an artifact can have.
      - `materializer` Source, required — Source specification. A source specifies a module name as well as an optional attribute of that module. These values can be used to import the module and get the value of the attribute inside the module. Example: The source `Source(module="zenml.config.source", attribute="Source")` references the class that this docstring is describing. This class is defined in the `zenml.config.source` module and the name of the attribute is the class name `Source`. Attributes: module: The module name. attribute: Optional name of the attribute inside the module. type: The type of the source.
        - `module` string, required
        - `attribute` string, nullable
        - `type` 'user' | 'builtin' | 'internal' | 'distribution_package' | 'code_repository' | 'notebook' | 'unknown', required — Enum representing different types of sources.
      - `data_type` Source, required — Source specification. A source specifies a module name as well as an optional attribute of that module. These values can be used to import the module and get the value of the attribute inside the module. Example: The source `Source(module="zenml.config.source", attribute="Source")` references the class that this docstring is describing. This class is defined in the `zenml.config.source` module and the name of the attribute is the class name `Source`. Attributes: module: The module name. attribute: Optional name of the attribute inside the module. type: The type of the source.
        - `module` string, required
        - `attribute` string, nullable
        - `type` 'user' | 'builtin' | 'internal' | 'distribution_package' | 'code_repository' | 'notebook' | 'unknown', required — Enum representing different types of sources.
      - `tags` TagResponse[], required
        - `body` TagResponseBody — Response body for tags.
          - `created` string, date-time, required
          - `updated` string, date-time, required
          - `color` 'grey' | 'purple' | 'red' | 'green' | 'yellow' | 'orange' | 'lime' | 'teal' | 'turquoise' | 'magenta' | 'blue' — All possible color variants for frontend.
          - `tagged_count` integer, required — The count of resources tagged with this tag.
        - `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.
      - `producer_pipeline_run_id` string, uuid, nullable
    - `metadata` ArtifactVersionResponseMetadata — Response metadata for artifact versions.
      - `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
      - `artifact_store_id` string, uuid, nullable
      - `producer_step_run_id` string, uuid, nullable
      - `visualizations` ArtifactVisualizationResponse[], nullable
        - `body` ArtifactVisualizationResponseBody — Response body for artifact visualizations.
          - `created` string, date-time, required
          - `updated` string, date-time, required
          - `type` 'csv' | 'html' | 'image' | 'markdown', required — All currently available visualization types.
          - `uri` string, required
        - `metadata` ArtifactVisualizationResponseMetadata — Response metadata model for artifact visualizations.
          - `artifact_version_id` string, uuid, required
        - `resources` ArtifactVisualizationResponseResources — Class for all resource models associated with the artifact visualization.
        - `id` string, uuid, required
        - `permission_denied` boolean
      - `run_metadata` object
    - `resources` ArtifactVersionResponseResources — Class for all resource models associated with the artifact version 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)