Get Community by ID

Retrieves details of a specific Community by its ID.

GET /2/communities/{id}

Get Community by ID

cURL

curl --request GET \
  --url https://api.x.com/2/communities/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "data": {
    "access": "<string>",
    "created_at": "<string>",
    "description": "<string>",
    "id": "<string>",
    "join_policy": "<string>",
    "member_count": 123,
    "name": "<string>"
  },
  "errors": [
    {
      "detail": "<string>",
      "resource_type": "<string>",
      "title": "<string>",
      "type": "https://api.x.com/2/problems/resource-not-found",
      "parameter": "<string>",
      "resource_id": "<string>",
      "status": 123,
      "value": "<string>"
    }
  ]
}

Authorizations

OAuth2UserTokenUserTokenBearerToken

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Scopes

users.read

View any account you can see, including protected accounts.

tweet.read

View all posts you can see, including those from protected accounts.

list.read

View Lists, members, and followers of Lists you created or are a member of, including private Lists.

Path Parameters

id · string · required

Unique identifier of a Community

Pattern: ^[0-9]{1,19}$

Query Parameters

community.fields · enum<string>[]

A comma separated list of Community fields to display. The fields available for a Community object.

Minimum array length: 1

Available options: access, created_at, description, id, join_policy, member_count, name

Response

200

application/json

The request has succeeded.

data · object

Show child attributes

errors · object[]

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Option 7

Option 8

Option 9

Option 10

Option 11

Option 12

Option 13

Option 14

Option 15

Option 16

Option 17

Option 18

Option 19

Option 20

Option 21

Option 22

Option 23

Option 24

Option 25

Option 26

Option 27

Option 28

Option 29

Option 30

Option 31

Option 32

Option 33

Option 34

Option 35

Option 36

Option 37

Option 38

Option 39

Option 40

Option 41

Option 42

Option 43

Option 44

Option 45

Option 46

Option 47

Option 48

Option 49

Option 50

Option 51

Option 52

Option 53

Option 54

Option 55

Option 56

Option 57

Option 58

Option 59

Option 60

Option 61

Show child attributes