---
title: "List Stack Components"
method: GET
path: "/api/v1/components"
tags: ["stack_components"]
---

# List Stack Components

`GET /api/v1/components`

Get a list of all stack components for a specific type.

Args:
    component_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 stack components for a specific type.

## 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
- `scope_type` string, nullable
- `name` string, nullable
- `flavor` string, nullable
- `type` string, nullable
- `workspace_id` union
  - string, uuid
  - string
- `user_id` union
  - string, uuid
  - string
- `connector_id` union
  - string, uuid
  - string
- `stack_id` union
  - string, uuid
  - string

## Response `200`

Successful Response

- PageComponentResponse
  - `index` integer, required
  - `max_size` integer, required
  - `total_pages` integer, required
  - `total` integer, required
  - `items` ComponentResponse[], required
    - `body` ComponentResponseBody — Response body for components.
      - `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.
      - `flavor` string, required
      - `integration` string, nullable
      - `logo_url` string, nullable
    - `metadata` ComponentResponseMetadata — Response metadata for components.
      - `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
      - `configuration` object, required
      - `labels` object, nullable
      - `component_spec_path` string, nullable
      - `connector_resource_id` string, nullable — The ID of a specific resource instance to gain access to through the connector
      - `connector` ServiceConnectorResponse — Response model for service connectors.
        - `body` ServiceConnectorResponseBody — Response body for service connectors.
          - `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
          - `description` string
          - `connector_type` union, required
            - string
            - ServiceConnectorTypeModel — Service connector type specification. Describes the types of resources to which the service connector can be used to gain access and the authentication methods that are supported by the service connector. The connector type, resource types, resource IDs and authentication methods can all be used as search criteria to lookup and filter service connector instances that are compatible with the requirements of a consumer (e.g. a stack component).
              - …
          - `auth_method` string, required
          - `resource_types` string[]
          - `resource_id` string, nullable
          - `supports_instances` boolean
          - `expires_at` string, date-time, nullable
          - `expires_skew_tolerance` integer, nullable
        - `metadata` ServiceConnectorResponseMetadata — Response metadata for service connectors.
          - `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
          - `configuration` object
          - `secret_id` string, uuid, nullable
          - `expiration_seconds` integer, nullable
          - `secrets` object
          - `labels` object
        - `resources` ServiceConnectorResponseResources — Class for all resource models associated with the service connector entity.
        - `id` string, uuid, required
        - `permission_denied` boolean
        - `name` string, required
    - `resources` ComponentResponseResources — Class for all resource models associated with the component 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)