---
title: "List communities"
method: GET
path: "/v1/communities"
tags: ["Communities"]
---

# List communities

`GET /v1/communities`

## Request

- Base URL: `https://api.subo.ai`
- URL: `https://api.subo.ai/v1/communities`
- Auth: API key in header `X-API-Key`

List all communities where the API key's user holds a creator or admin role.

## Response `200`

List of communities

- object
  - `data` Community[]
    - `id` string
    - `name` string
    - `platform` 'discord'
    - `tier` 'basic' | 'premium' | 'vip' | 'custom'
    - `bot_credits` integer
    - `locale` string, nullable
    - `icon_url` string, nullable
    - `created_date` string, date-time, nullable
    - `total_project_count` integer: Total number of projects ever created
    - `active_project_count` integer: Number of currently active (live or pending) projects
    - `topics` string[]: Community topic tags
    - `user_setup_id` string, nullable: Internal Subo user ID of the member who last completed the community bot setup wizard. Read-only. Null if setup has not been run.

## Other responses

- `401`: Invalid or missing API key
- `429`: Rate limit exceeded — wait `retry_after` seconds before retrying. The same value appears in the `Retry-After` header.

---

[API](https://skmtc.dev/subo/apis/subo-api.md) · [All operations](https://skmtc.dev/subo/apis/subo-api/llms.txt) · [OpenAPI document](https://skmtc.dev/subo/apis/subo-api/revisions/12eab2ae4505?raw)