---
title: "List deployment groups."
method: GET
path: "/v1/groups"
tags: ["groups"]
---

# List deployment groups.

`GET /v1/groups`

## Request

- Base URL: `https://api.smolmachines.com`
- URL: `https://api.smolmachines.com/v1/groups`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/smolmachines/apis/smolfleet-api/docs/v1/groups/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns every group in the caller's tenant with replica and instance status. Requires a valid API key for the tenant; no specific scope.

## Response `200`

List groups

- GroupInfo[]
  - `createdAt` string, required
  - `domain` string, nullable
  - `id` string, required
  - `image` string, required
  - `instances` InstanceInfo[], required
    - `generation` integer, required
    - `hostPort` integer, nullable
    - `id` string, required
    - `nodeId` string, required
    - `status` string, required
  - `name` string, required
  - `port` integer, required
  - `replicas` integer, required
  - `status` string, required
  - `updatedAt` string, required

## Other responses

- `401`: Missing or invalid API key
- `403`: Key lacks the required scope
- `429`: Rate limited; retry after the Retry-After header
- `500`: Internal error

## Changes

- **2026-10-16** `bc31fc04a568`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/smolmachines/apis/smolfleet-api/changes/v1/groups/get.md)

---

[API](https://skmtc.dev/smolmachines/apis/smolfleet-api.md) - [All operations](https://skmtc.dev/smolmachines/apis/smolfleet-api/llms.txt) - [OpenAPI document](https://skmtc.dev/smolmachines/apis/smolfleet-api/revisions/bc31fc04a568?raw)