Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

X (Twitter) Communities API

The Communities API from X (Twitter) — 2 operation(s) for communities.

X (Twitter) Communities API is one of 23 APIs that X (Twitter) publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Communities. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, an API reference, authentication docs, and rate-limit docs.

This API exposes 2 operations across 2 paths, and defines 7 schemas. It is described by OpenAPI 3.0.0, at version 2.161.

Requests are made against a single base URL, https://api.x.com.

2 operations 2 paths 7 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.161
Base URL
https://api.x.com/2
Authentication
HTTP Bearer, OAuth 2.0, HTTP Oauth
Terms of Service
Resource Areas
1

Authentication & Security 3

X (Twitter) Communities API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (BearerToken). It supports OAuth 2.0 (OAuth2UserToken) using the authorizationCode flow, exposing 21 scopes. It uses HTTP oauth authentication (UserToken).

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Communities 2
GET
/2/communities/search
X Search Communities
searchCommunities 5 params → 200default
GET
/2/communities/{id}
X Get Community by ID
getCommunitiesById 2 params → 200default

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Problem (4 properties), Get2CommunitiesSearchResponse (3 properties), Community (3 properties), Get2CommunitiesIdResponse (2 properties). Each schema is shown below with its type and property counts.

CommunityId
string
The unique identifier of this Community.
NextToken
string
The next token.
Problem
object
An HTTP Problem Details object, as defined in IETF RFC 7807 (https://tools.ietf.org/html/rfc7807).
4 properties 2 required
Community
object
A X Community is a curated group of Posts.
3 properties 2 required
Error
object
2 properties 2 required
Get2CommunitiesSearchResponse
object
3 properties
Get2CommunitiesIdResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

twitter-communities-api-openapi.yml Raw ↑

Other APIs X (Twitter) publishes across the network.

X Ads API
X Activity API
X (Twitter) Account Activity API
X (Twitter) Activity API
X (Twitter) Bookmarks API
X (Twitter) Chat API
X (Twitter) Community Notes API
X (Twitter) Compliance API
X (Twitter) Connections API
X (Twitter) Direct Messages API
X (Twitter) General API
X (Twitter) Likes API