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

# GET /components

`GET /components`

## Response `200`

List all registered components

- object[]
  - `id` string
  - `slug` string
  - `name` string
  - `version` string
  - `type` string
  - `category` 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
    - `type` union
      - 'string' | 'array' | 'object' | 'file' | 'secret' | 'number'
      - string[]
    - `required` boolean
    - `description` string, nullable
  - `outputs` object[]
    - `id` string
    - `label` string
    - `type` 'string' | 'array' | 'object' | 'file' | 'secret' | 'number'
    - `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[]

## Changes

- **2025-10-24** `8db531c050e5` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/shipsecai/apis/shipsec-studio-api/changes/components/get.md)

---

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