---
title: "List Artifacts"
method: GET
path: "/api/v1/artifacts"
tags: ["artifacts"]
---

# List Artifacts

`GET /api/v1/artifacts`

Get artifacts according to query filters.

Args:
    artifact_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 artifacts 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
- `name` string, nullable
- `has_custom_name` boolean, nullable

## Response `200`

Successful Response

- PageArtifactResponse
  - `index` integer, required
  - `max_size` integer, required
  - `total_pages` integer, required
  - `total` integer, required
  - `items` ArtifactResponse[], required
    - `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.
          - `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.
      - `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

## 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)