---
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'

## Response `200`

All communities

- CommunityPaginatedResponseDto
  - `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` ObjectId, 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-04-04** `aa4804c758aa` — 1 info
  - endpoint added
- **2023-04-04** `9acb2632a6fd` — 1 breaking
  - api path removed without deprecation
- **2023-04-03** `e1a32d8c1997` — 1 info
  - endpoint added
- **2023-04-03** `872dae15b4ba` — 1 breaking
  - api path removed without deprecation
- **2023-03-31** `af4ea0086c6f` — 2 breaking, 1 warning, 1 info
  - the `docs/items/_id` response's property type/format changed from `string`/`` to ``/`` for status `200`
  - removed the required property `docs/items/features` from the response with the `200` status
  - deleted the `query` request parameter `hostname`
  - added `#/components/schemas/ObjectId` to the `docs/items/_id` response property `allOf` list for the response status `200`

[Change 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/1c866f9dfd40/schema)