How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Commune Engagement API

What Commune knows about one subscriber that a newsletter's email providercannot answer: engagement scored across the inbox and the communitytogether, and the raw event stream those scores are summed from. Rowshaped and high cardinality, which is what a CRM or a re-engagementautomation reads. Needs `insights`, and part of the one read surface Communemay put behind a plan.

Commune Engagement API is one of 18 APIs that Commune publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 6 JSON Schema definitions.

Tagged areas include Engagement. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 6 JSON Schemas.

This API exposes 2 operations across 2 paths, and defines 24 schemas. It is described by OpenAPI 3.2.0, at version 2026-08-26.

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

2 operations 2 paths 24 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2026-08-26
Base URL
https://api.usecommune.com
Authentication
OAuth 2.0, HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 2

Commune Engagement 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 2

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

Engagement 2

What Commune knows about one subscriber that a newsletter's email provider cannot answer: engagement scored across the inbox and the community together, and the raw event stream t…

GET
/newsletters/{newsletter}/insights
List a newsletter's subscriber insights
listNewsletterInsights 8 params → 200400401402403404429500
GET
/newsletters/{newsletter}/events
List a newsletter's engagement events
listNewsletterEvents 8 params → 200400401402403404429500

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are Article (18 properties), Thread (16 properties), Newsletter (16 properties), SubscriberInsight (13 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…
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 properties 3 required
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 properties 2 required
EngagementEventSource
string
Which side of the newsletter an event came from. community is behaviour Commune observed itself. esp is behaviour the newsletter's email provider reported, so…
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 properties 2 required
Ref
object
An unexpanded relationship. Ask for the relationship in ?expand= to get the full object in its place.
2 properties 2 required
Media
object
An image or file attached to a thread or a message.
3 properties 1 required
Thread
object
A conversation in a newsletter's community, together with the message that opened it. Its replies are a separate collection.
16 properties 8 required
InsightStatus
string
Where a reader sits in the newsletter's engagement ladder, from dormant at the bottom to superfan at the top. Assigned by rank inside the newsletter rather tha…
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 property 1 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.…
Tag
object
A segment of a newsletter's audience. A tag is what makes an article audience scoped: sending to a tag stamps the article, and from then on only holders of tha…
8 properties 6 required
EngagementEvent
object
One scored action by one reader, unaggregated, so a consumer can build its own model rather than take Commune's scores. The subscriber insight scores are summe…
9 properties 8 required
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 properties 6 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 properties 8 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…
EngagementEventType
string
What a reader did. The first five happen on Commune and the last two are reported by the newsletter's email provider, which is what source records.
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 properties 3 required
SubscriberInsight
object
One reader's engagement with one newsletter, scored across both the email and the community. Recomputed on a schedule, not at read time. Scores have no unit an…
13 properties 11 required
SubscriberStatus
string
Where a subscription stands. Source of truth for a commune newsletter. For a newsletter connected to an outside provider it reflects what Commune last saw of t…
InsightVelocity
string
Which way a reader's engagement is moving, from the last fourteen days against the fourteen before them. steady also covers a reader with no activity in either…
Subscriber
object
One person's membership of one newsletter. The same person subscribing to two newsletters is two subscribers, and one creator never sees the other's row. A sub…
10 properties 6 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…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

usecommune-engagement-api-openapi.yml Raw ↑

Other APIs Commune publishes across the network.

Commune Articles API
Commune Event delivery API
Commune Highlights API
Commune Messages API
Commune Metrics API
Commune Newsletters API
Commune Platform API
Commune Search API
Commune Senders API
Commune Sends API
Commune Subscriber tags API
Commune Subscribers API
Where this information came from

This is an independent, third-party profile of Commune Engagement 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.