---
title: "List Deployments"
method: GET
path: "/v1/deployments"
tags: ["deployments"]
---

# List Deployments

`GET /v1/deployments`

## Request

- Base URL: `https://api.usekeel.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.usekeel.io/v1/deployments`
- Auth: none declared

List deployments in the current org, of the classes ``capital_class`` names.

Paper Trading v2, S01 §3.10 / IC-01-9: one positive predicate for every
value, ``COALESCE(a.capital_class, 'real') = ANY(%s)``, with ``all``
naming ``CAPITAL_CLASSES``. The account is LEFT JOINed so a deployment
whose account row does not exist keeps its pre-paper meaning: ``real``,
in the default list and in ``all``, never in ``practice``, with a null
venue code. Every row carries its venue block.

## Query parameters

- `cursor` string, nullable
- `limit` integer
- `include_stopped` boolean
- `capital_class` 'real' | 'practice' | 'all': Money class to list: real, practice or all. Absent means real (PT2-28); all returns every row with its venue block.

## Headers

- `Authorization` string, nullable
- `X-Org-Id` string, nullable

## Response `200`

Successful Response

- PaginatedResponse
  - `data` unknown[], required
    - unknown
  - `pagination` PaginationMeta, required
    - `cursor` string, nullable
    - `has_more` boolean

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/usekeel/apis/keel-api.md) · [All operations](https://skmtc.dev/usekeel/apis/keel-api/llms.txt) · [OpenAPI document](https://skmtc.dev/usekeel/apis/keel-api/revisions/3191ca10b0ab?raw)
