Docs
Community about page

Community about page

The About page of a community: description, rules, creation date, moderators and a preview of members.

GET/communities/{communityId}/about
Draft. The parameters on this page have not been checked against the API code yet. Make a test call before you build on it.

Parameters

  • communityIdpath · string · required

    Numeric community ID, the number in the community URL.

Notes

  • No simple format: with format=simple the response is the same as without it.

Example request

curl 'https://api.twittrapi.com/communities/1500000000000000000/about' \
  --header 'X-API-KEY: YOUR_API_KEY'

Base URL https://api.twittrapi.com, key in the X-API-KEY header. Python and Node.js use the official SDKs.

Response

Raw JSON of X's CommunityAboutTimeline query.

Example response coming soon.

In the raw format, field names and nesting come from X and can change without notice. See Response format.

Errors

  • 422communityId is not numeric.

Errors every endpoint can return (401, 402, 403, 404, 408, 409, 429, 5xx), and which of them are charged, are on the Errors page. Calls that fail with 400, 407, 408, 409 or a 5xx error are refunded.