Skip to content

Community Details

GET/tw-v2/community/details

1 API unit per call · How billing works

Description

Get detailed information about a specific community including metadata, member count, and settings.

Parameters

ParameterDescription
communityIdstringrequiredUnique community ID

Code Examples

const params = new URLSearchParams({
  communityId: '1234567890'
});

const response = await fetch(`https://api.tweetapi.com/tw-v2/community/details?${params}`, {
  method: 'GET',
  headers: {
    'X-API-Key': 'YOUR_API_KEY'
  }
});

const data = await response.json();
console.log(data);

Response

Success Response (200 OK)

200
{
  "data": {
    "id": "9001746993033726229",
    "name": "Sample User 80101",
    "description": "Sample profile bio for Sample User 64708.",
    "memberCount": 12000,
    "moderatorCount": 0,
    "adminCount": 1,
    "createdAt": "2023-01-02T00:00:00.000Z",
    "rules": [
      {
        "id": "Q29tbXVuaXR5UnVsZToxMDAwMDAwMDAwMDAwMDAwMDEx",
        "name": "Be respectful",
        "description": "",
        "order": 0,
        "createdAt": ""
      },
      {
        "id": "Q29tbXVuaXR5UnVsZToxMDAwMDAwMDAwMDAwMDAwMDEy",
        "name": "Stay on topic",
        "description": "Sample description for documentation 20706.",
        "order": 1,
        "createdAt": ""
      },
      {
        "id": "Q29tbXVuaXR5UnVsZToxMDAwMDAwMDAwMDAwMDAwMDEz",
        "name": "No spam",
        "description": "",
        "order": 2,
        "createdAt": ""
      },
      {
        "id": "Q29tbXVuaXR5UnVsZToxMDAwMDAwMDAwMDAwMDAwMDE0",
        "name": "No links",
        "description": "",
        "order": 3,
        "createdAt": ""
      },
      {
        "id": "Q29tbXVuaXR5UnVsZToxMDAwMDAwMDAwMDAwMDAwMDE1",
        "name": "Keep it civil",
        "description": "",
        "order": 4,
        "createdAt": ""
      }
    ],
    "isPrivate": false,
    "isMember": false,
    "isModerator": false,
    "isAdmin": false,
    "isBanned": false,
    "canPost": true,
    "bannerUrl": "https://example.com/images/sample-banner-64708.jpg",
    "avatarUrl": null,
    "joinRequestsEnabled": false,
    "pinnedTweetId": null
  }
}