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

# GET /api/communities

`GET /api/communities`

## Query parameters

- `limit` number, required
- `page` number, required
- `sortColumn` string
- `sortType` 'asc' | 'desc'
- `hostname` string

## Response `200`

All communities

- CommunityFindAllResponseDto
  - `totalDocs` number, required
  - `limit` number, required
  - `totalPages` number, required
  - `page` number
  - `pagingCounter` number, required
  - `hasPrevPage` object, required
  - `hasNextPage` object, required
  - `prevPage` object
  - `nextPage` object
  - `docs` Community[], required
    - `_id` string, required
    - `hostname` string, required
    - `name` string, required
    - `email` string, required
    - `creator` string, required
    - `owners` string[], required
    - `discordGuildId` string
    - `discordLinkNonce` string, required
    - `isPublic` boolean, required
    - `discordLinkState` 'NOT_SET' | 'PENDING' | 'ACTIVE' | 'DEACTIVE', required
  - `meta` object

## Changes

- **2023-08-18** `038d95bf55fd` — 1 info
  - added the new optional `query` request parameter `hostname`
- **2023-08-11** `00d037b830a5` — 1 warning
  - deleted the `query` request parameter `hostname`
- **2023-08-03** `c9993f2c6ebd` — 1 info
  - added the new optional `query` request parameter `hostname`
- **2023-05-22** `35689df7019c` — 1 breaking, 1 info
  - the `docs/items/_id` response's property type/format changed from ``/`` to `string`/`` for status `200`
  - removed `#/components/schemas/ObjectId` from the `docs/items/_id` response property `allOf` list for the response status `200`
- **2023-04-27** `e14b4c818c53` — 1 info
  - endpoint added

[Full history](https://skmtc.dev/givepraise/apis/praise-api/changes/api/communities/get.md)

---

[API](https://skmtc.dev/givepraise/apis/praise-api.md) · [All operations](https://skmtc.dev/givepraise/apis/praise-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/givepraise/praise-api/revisions/038d95bf55fd/schema)