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

# GET /api/v1/components

`GET /api/v1/components`

Retrieves multiple components.

## Query parameters

- `ids` union
  - string[]
  - string, uuid — A UUID v4 string that identifies an entity.
- `pageNumber` number — The page number.
- `pageSize` number — The page size.
- `search` string — Search term to filter components by key.
- `versionIds` union
  - string[]
  - string, uuid — A UUID v4 string that identifies an entity.

## Headers

- `authorization` string, required — The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

## Response `200`

Retrieves all components for the workspace.

- object[]
  - `createdAt` string, date-time, required
  - `id` string, uuid, required — A UUID v4 string that identifies an entity.
  - `isRemoved` boolean, required
  - `referenceId` string, uuid, nullable, required — The ID of the original entity in production.
  - `updatedAt` string, date-time, required
  - `versionId` string, uuid, required — A UUID v4 string that identifies an entity.
  - `detail` union, required — The detail configuration of the component.
    - object
      - `type` 'boolean', required
      - `value` boolean, required
    - object
      - `type` 'number', required
      - `value` number, required
    - object
      - `type` 'string', required
      - `value` string, required
  - `key` string, required — The unique key identifier for this component within the workspace.
  - `workspaceId` string, uuid, required — The workspace that owns this component.

## Other responses

- `401` — Unauthorized.

---

[API](https://skmtc.dev/zaia/apis/public-api.md) · [All operations](https://skmtc.dev/zaia/apis/public-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zaia/public-api/revisions/58da3b2ba49f/schema)