---
title: "List Flavors"
method: GET
path: "/api/v1/flavors"
tags: ["flavors"]
---

# List Flavors

`GET /api/v1/flavors`

Returns all flavors.

Args:
    flavor_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:
    All flavors.

## 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
- `name` string, nullable
- `type` string, nullable
- `integration` string, nullable
- `workspace_id` union
  - string, uuid
  - string
- `user_id` union
  - string, uuid
  - string

## Response `200`

Successful Response

- PageFlavorResponse
  - `index` integer, required
  - `max_size` integer, required
  - `total_pages` integer, required
  - `total` integer, required
  - `items` FlavorResponse[], required
    - `body` FlavorResponseBody — Response body for flavor.
      - `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
      - `type` 'alerter' | 'annotator' | 'artifact_store' | 'container_registry' | 'data_validator' | 'experiment_tracker' | 'feature_store' | 'image_builder' | 'model_deployer' | 'orchestrator' | 'step_operator' | 'model_registry', required — All possible types a `StackComponent` can have.
      - `integration` string, nullable, required
      - `logo_url` string, nullable
    - `metadata` FlavorResponseMetadata — Response metadata for flavors.
      - `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
      - `config_schema` object, required
      - `connector_type` string, nullable
      - `connector_resource_type` string, nullable
      - `connector_resource_id_attr` string, nullable
      - `source` string, required
      - `docs_url` string, nullable
      - `sdk_docs_url` string, nullable
      - `is_custom` boolean
    - `resources` FlavorResponseResources — Class for all resource models associated with the flavor 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/revisions/febb01b8bce3/schema)