---
title: "Community details"
method: GET
path: "/communities/{communityId}"
tags: ["Communities"]
---

# Community details

`GET /communities/{communityId}`

## Request

- Base URL: `https://api.twittrapi.com`
- URL: `https://api.twittrapi.com/communities/{communityId}`
- Auth: API key in header `X-API-KEY`

Name, description, rules, member count and admins of a community.

Reference: https://www.twittrapi.com/docs/reference/communities-communityid

## Path parameters

- `communityId` string, required

## Query parameters

- `format` 'raw' | 'simple'

## Response `200`

Raw JSON of X's CommunityQuery.

With format=simple: {data: Community}.

- union: format=simple: the simple-format schema. Default (raw): X's JSON, passthrough.
  - CommunityResult: Simple format: one community
    - `data` Community, required
      - `id` string, required
      - `name` string, required
      - `description` string, required: Empty in search results
      - `createdAt` string, nullable, required
      - `memberCount` integer, required
      - `moderatorCount` integer, required
      - `joinPolicy` string, nullable, required
      - `nsfw` boolean, required
      - `topic` string, nullable, required
      - `bannerUrl` string, nullable, required
      - `creator` object, nullable, required
        - `id` string, required
        - `username` string, required
      - `rules` object[], required
        - `id` string, required
        - `name` string, required
        - `description` string, required
  - RawPassthrough: X's own JSON (raw format, the default), passed through unchanged. The shape is X's and can change; see https://www.twittrapi.com/docs/response-format.

## Other responses

- `401`: Missing or unknown API key. Not charged.
- `402`: No balance left, or the trial expired. Not charged. Top up in the dashboard.
- `403`: Key deactivated, or the endpoint is not in your plan (trial keys and account actions). Not charged.
- `422`: communityId is not numeric.
- `429`: Rate limit for your key exceeded. Not charged. No Retry-After header: back off exponentially.
- `500`: Something failed on our side or between us and X. Refunded (400, 407, 408, 409 or a 5xx error are refunded). Retry with backoff.

---

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