The API's own machinery rather than any newsletter's data: the readinessprobe, what a credential has left of its rate limit budgets, what itsnewsletter's plan allows, and the newsletter's API keys. A key can belisted and revoked here but never created, so a stolen credential cannotmint itself a replacement.
Commune Platform API declares
2 security schemes
for authenticating requests.
It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 13 scopes.
It accepts HTTP bearer tokens (Commune API key) (apiKey).
By default, every request must be authenticated.
oauth2 — An OAuth access token, sent as Authorization: Bearer . The walkthrough of the whole flow is at [usecommune.dev/use-cases/build-an-integration](https://usecommu…
apiKey — A Commune API key, sent as Authorization: Bearer . A key is granted one or more newsletters and carries six permission families on each, every one of them none…
Paths & Operations 6
Across 5 paths, the API surfaces 6 operations — 1 DELETE, 5 GET. Each is listed below with its method, path, parameters, and response codes.
Platform 6
The API's own machinery rather than any newsletter's data: the readiness probe, what a credential has left of its rate limit budgets, what its newsletter's plan allows, and the ne…
GET
/status
Service status
getStatus→ 200429500
GET
/rate-limit
Retrieve the calling credential's rate limit state
The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are Article (18 properties), Thread (16 properties), Newsletter (16 properties), ApiKey (15 properties). Each schema is shown below with its type and property counts.
ArticleStatus
string
Where an article is in its life. A credential holding only read permissions ever sees sent and nothing else. An imported article is always sent, since Commune…
Pagination
object
Cursor pagination state. Commune never exposes an offset or a page number: a collection is a moving window, and an offset silently skips or repeats items when…
2 properties2 required
SocialLinks
object
The creator's other homes on the internet, stored as canonical profile URLs. Every key is optional and a newsletter that set none returns an empty object.
8 properties
ArticleStats
object
Engagement counts for an article, computed at read time. These are Commune side counts, not provider side email metrics: opens, clicks and deliveries are not h…
3 properties3 required
PermissionLevel
string
How much of one family a credential holds on one newsletter. none is no access at all. read reads that part of the newsletter as it has been published. write a…
User
object
A person's public profile, and the whole of what this API returns about anybody other than the credential's own owner. Email address, theme, notification prefe…
5 properties2 required
Ref
object
An unexpanded relationship. Ask for the relationship in ?expand= to get the full object in its place.
2 properties2 required
Media
object
An image or file attached to a thread or a message.
3 properties1 required
Thread
object
A conversation in a newsletter's community, together with the message that opened it. Its replies are a separate collection.
16 properties8 required
Error
object
The error envelope. Every non 2xx response from every operation has this shape, so a client can branch on error.code without knowing which operation produced i…
1 property1 required
Esp
string
Where a newsletter is published from. commune means Commune itself sends the email. Every other value is an email service provider whose posts Commune imports.…
ApiKey
object
A credential, as it can be described without its secret. The secret is not here and no parameter brings it back. Commune stores a digest of it and shows the pl…
15 properties11 required
ServiceStatus
object
The service's own health, the state of what it depends on, and the contract version it is currently serving.
4 properties4 required
Entitlements
object
What this newsletter's plan includes, and what a key bound to it may call. Read it before the first write of a reconciliation rather than after the 402 that st…
5 properties5 required
DependencyState
string
How a single dependency answered its last check. up is a successful answer, degraded is an answer that arrived but was slow or partial, and down is no usable a…
Newsletter
object
A newsletter and its public profile. Nothing operational is exposed: ESP credentials, OAuth tokens, group and audience ids, feed polling state and language det…
16 properties6 required
Article
object
One article of a newsletter, without its body. Every collection of articles returns this shape. GET /articles/{article} returns ArticleWithContent, which is th…
18 properties8 required
ThreadVisibility
string
Where a thread is placed. public puts it on the global Commune feed and makes it readable by anyone. subscribers keeps it inside the newsletter. paid narrows i…
MeteredFeature
string
Something in this API that can be put behind a plan. There are two: reads are free, with one exception. writes covers every operation that changes something. i…
ListEnvelope
object
The envelope every collection is returned in. data holds the page, pagination holds the cursor state. data is required here and typed by each list operation, a…
2 properties3 required
Dependency
object
One capability the API depends on, and how it answered. required is the field that matters when deciding what to do about a failure: a required dependency bein…
4 properties4 required
NewsletterPermissions
object
What a credential may do on one newsletter, family by family. Every family is always present, so a client never has to decide what an absent one means. What a…
6 properties6 required
RateLimitPolicy
object
One budget a key is measured against. A request is charged to every budget that applies to its operation, and has to pass all of them.
7 properties7 required
RateLimit
object
A key's rate limit state. The top level fields repeat the general budget, which every request is charged to; policies carries every budget, which is what a cli…
6 properties6 required
ErrorCode
string
The stable, machine readable reason a request failed. New codes may be added in a minor version, so treat an unrecognised code as a generic failure of its HTTP…
Entitlement
object
One capability, and whether this newsletter's key has it. granted answers "will my next call work". included answers "does this plan carry the capability at al…
7 properties7 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Commune Platform API, published by
API Evangelist. We do not operate, host, resell, or
support these APIs, and we are not affiliated with or endorsed by the company unless stated above.
Everything here is built from publicly available information — the company's own site,
developer portal, documentation, public repositories, and the specifications it publishes for public use.
Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's
public API artifacts, scored against a published rubric. They are not certifications,
endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and
you do not need to justify the request. A removed company is recorded as unrated, never scored
zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy → On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.
