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

# GET /api/v1/components

`GET /api/v1/components`

## Response `200`

List all registered components

- object[]
  - `id` string
  - `slug` string
  - `name` string
  - `version` string
  - `type` string
  - `category` string
  - `categoryConfig` object
    - `label` string
    - `color` string
    - `description` string
    - `emoji` string
    - `icon` string
  - `description` string
  - `documentation` string, nullable
  - `documentationUrl` string, nullable
  - `icon` string
  - `logo` string, nullable
  - `isLatest` boolean, nullable
  - `deprecated` boolean, nullable
  - `example` string, nullable
  - `author` object, nullable
    - `name` string
    - `type` 'shipsecai' | 'community'
    - `url` string, nullable
  - `runner` object
    - `kind` 'inline' | 'docker' | 'remote'
    - `image` string, nullable
    - `command` string[], nullable
  - `inputs` object[]
    - `id` string
    - `label` string
    - `connectionType` object
      - `kind` 'primitive' | 'list' | 'map' | 'contract' | 'any', required
      - `name` string, nullable
      - `element` object, nullable
      - `credential` boolean, nullable
    - `editor` 'text' | 'textarea' | 'number' | 'boolean' | 'select' | 'multi-select' | 'json' | 'secret', nullable
    - `required` boolean
    - `description` string, nullable
    - `valuePriority` 'manual-first' | 'connection-first', nullable
  - `outputs` object[]
    - `id` string
    - `label` string
    - `connectionType` object
      - `kind` 'primitive' | 'list' | 'map' | 'contract' | 'any', required
      - `name` string, nullable
      - `element` object, nullable
      - `credential` boolean, nullable
    - `description` string, nullable
  - `parameters` object[]
    - `id` string
    - `label` string
    - `type` 'text' | 'textarea' | 'number' | 'boolean' | 'select' | 'multi-select' | 'json' | 'secret'
    - `required` boolean
    - `default` unknown
    - `placeholder` string, nullable
    - `description` string, nullable
    - `helpText` string, nullable
    - `options` object[], nullable
      - `label` string
      - `value` unknown
    - `min` number, nullable
    - `max` number, nullable
    - `rows` number, nullable
  - `examples` string[]
  - `toolProvider` object, nullable
    - `kind` 'component' | 'mcp-server' | 'mcp-group'
    - `name` string
    - `description` string

---

[API](https://skmtc.net/shipsecai/apis/shipsec-studio-api.md) · [All operations](https://skmtc.net/shipsecai/apis/shipsec-studio-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/shipsecai/shipsec-studio-api/revisions/cc60562ad9f3/schema)
