# Commune API

> This is version `2026-08-26` of this API documentation. Last update on Nov 18, 2026.
> The Commune API exposes a Commune community: newsletters, the articles they
> publish, the chat threads those articles start, and the people who write
> and read them.
> 
> Most of it is reading. A small set of operations changes something, and
> those behave differently in three ways described under Writes below.

[Documentation](https://api-reference.usecommune.dev/source.md)

OpenAPI file: https://api-reference.usecommune.dev/source.yaml

## MCP server

Connect AI agents to this documentation with the REST API MCP server (Model Context Protocol, no authentication, Streamable HTTP transport):

- URL: `https://api-reference.usecommune.dev/mcp`

## [Servers](https://api-reference.usecommune.dev/servers.md)
- Production. There is no separate sandbox host.
: https://api.usecommune.com (Production. There is no separate sandbox host.
)


## Topics

### [Authentication](https://api-reference.usecommune.dev/authentication.md)

### [Versioning](https://api-reference.usecommune.dev/topic/topic-versioning.md)

### [Rate limits](https://api-reference.usecommune.dev/topic/topic-rate-limits.md)

### [Writes](https://api-reference.usecommune.dev/topic/topic-writes.md)

### [Pagination](https://api-reference.usecommune.dev/topic/topic-pagination.md)

### [Identifiers](https://api-reference.usecommune.dev/topic/topic-identifiers.md)

### [Fetching this document](https://api-reference.usecommune.dev/topic/topic-fetching-this-document.md)

### [Removals](https://api-reference.usecommune.dev/topic/topic-removals.md)


## Newsletters and people

### [Newsletters](https://api-reference.usecommune.dev/group/endpoint-newsletters.md)

- [List newsletters](https://api-reference.usecommune.dev/operation/operation-listnewsletters.md)

- [Retrieve a newsletter](https://api-reference.usecommune.dev/operation/operation-getnewsletter.md)


### [Team](https://api-reference.usecommune.dev/group/endpoint-team.md)

- [List a newsletter's team](https://api-reference.usecommune.dev/operation/operation-listnewslettermembers.md)

- [List this account's memberships](https://api-reference.usecommune.dev/operation/operation-listmemberships.md)


### [Users](https://api-reference.usecommune.dev/group/endpoint-users.md)

- [Retrieve the authenticated account](https://api-reference.usecommune.dev/operation/operation-getme.md)

- [Retrieve a user](https://api-reference.usecommune.dev/operation/operation-getuser.md)


### [Search](https://api-reference.usecommune.dev/group/endpoint-search.md)

- [Search your newsletters](https://api-reference.usecommune.dev/operation/operation-search.md)



## Publishing

### [Articles](https://api-reference.usecommune.dev/group/endpoint-articles.md)

- [List a newsletter's articles](https://api-reference.usecommune.dev/operation/operation-listnewsletterarticles.md)

- [Create an article](https://api-reference.usecommune.dev/operation/operation-createarticle.md)

- [Retrieve an article](https://api-reference.usecommune.dev/operation/operation-getarticle.md)

- [Edit an article](https://api-reference.usecommune.dev/operation/operation-updatearticle.md)

- [List an article's authors](https://api-reference.usecommune.dev/operation/operation-listarticleauthors.md)

- [Store an image for an article](https://api-reference.usecommune.dev/operation/operation-createarticleimage.md)

- [Send a test copy of an article](https://api-reference.usecommune.dev/operation/operation-sendarticletest.md)

- [Schedule an article](https://api-reference.usecommune.dev/operation/operation-schedulearticle.md)

- [Cancel a scheduled article](https://api-reference.usecommune.dev/operation/operation-unschedulearticle.md)

- [Send an article to the list](https://api-reference.usecommune.dev/operation/operation-sendarticle.md)

- [List the articles this account saved](https://api-reference.usecommune.dev/operation/operation-listsavedarticles.md)

- [List the articles this account liked](https://api-reference.usecommune.dev/operation/operation-listlikedarticles.md)


### [Highlights](https://api-reference.usecommune.dev/group/endpoint-highlights.md)

- [List an article's highlights](https://api-reference.usecommune.dev/operation/operation-listarticlehighlights.md)

- [Retrieve a highlight](https://api-reference.usecommune.dev/operation/operation-gethighlight.md)



## Community

### [Threads](https://api-reference.usecommune.dev/group/endpoint-threads.md)

- [List a newsletter's threads](https://api-reference.usecommune.dev/operation/operation-listnewsletterthreads.md)

- [Start a thread](https://api-reference.usecommune.dev/operation/operation-createthread.md)

- [Retrieve a thread](https://api-reference.usecommune.dev/operation/operation-getthread.md)

- [Set who a conversation is private to](https://api-reference.usecommune.dev/operation/operation-updatethread.md)

- [Put a thread on the global feed](https://api-reference.usecommune.dev/operation/operation-publishthread.md)

- [Reply in a thread](https://api-reference.usecommune.dev/operation/operation-createmessage.md)


### [Messages](https://api-reference.usecommune.dev/group/endpoint-messages.md)

- [List a thread's messages](https://api-reference.usecommune.dev/operation/operation-listthreadmessages.md)

- [Retrieve a message](https://api-reference.usecommune.dev/operation/operation-getmessage.md)


### [Chat rooms](https://api-reference.usecommune.dev/group/endpoint-chat-rooms.md)

- [List a newsletter's chat rooms](https://api-reference.usecommune.dev/operation/operation-listnewsletterrooms.md)

- [Retrieve a chat room](https://api-reference.usecommune.dev/operation/operation-getroom.md)



## Audience

### [Subscribers](https://api-reference.usecommune.dev/group/endpoint-subscribers.md)

- [List a newsletter's subscribers](https://api-reference.usecommune.dev/operation/operation-listnewslettersubscribers.md)

- [Add a subscriber](https://api-reference.usecommune.dev/operation/operation-createsubscriber.md)

- [Retrieve a subscriber](https://api-reference.usecommune.dev/operation/operation-getsubscriber.md)

- [Erase a subscriber](https://api-reference.usecommune.dev/operation/operation-deletesubscriber.md)

- [Update a subscriber](https://api-reference.usecommune.dev/operation/operation-updatesubscriber.md)

- [List the newsletters this account subscribes to](https://api-reference.usecommune.dev/operation/operation-listsubscriptions.md)

- [List a newsletter's community](https://api-reference.usecommune.dev/operation/operation-listnewslettercommunity.md)


### [Subscriber tags](https://api-reference.usecommune.dev/group/endpoint-subscriber-tags.md)

- [List a newsletter's tags](https://api-reference.usecommune.dev/operation/operation-listnewslettertags.md)

- [Create a tag](https://api-reference.usecommune.dev/operation/operation-createtag.md)

- [Retrieve a tag](https://api-reference.usecommune.dev/operation/operation-gettag.md)

- [Delete a tag](https://api-reference.usecommune.dev/operation/operation-deletetag.md)

- [Rename a tag](https://api-reference.usecommune.dev/operation/operation-updatetag.md)

- [Apply a tag to many subscribers](https://api-reference.usecommune.dev/operation/operation-addtagsubscribers.md)

- [Apply a tag to a subscriber](https://api-reference.usecommune.dev/operation/operation-addsubscribertag.md)

- [Take a tag off a subscriber](https://api-reference.usecommune.dev/operation/operation-removesubscribertag.md)


### [Forms](https://api-reference.usecommune.dev/group/endpoint-forms.md)

- [List a newsletter's signup forms](https://api-reference.usecommune.dev/operation/operation-listnewsletterforms.md)

- [Create a signup form](https://api-reference.usecommune.dev/operation/operation-createform.md)

- [Retrieve a signup form](https://api-reference.usecommune.dev/operation/operation-getform.md)

- [Delete a signup form](https://api-reference.usecommune.dev/operation/operation-deleteform.md)

- [Update a signup form](https://api-reference.usecommune.dev/operation/operation-updateform.md)

- [Retrieve the form defaults](https://api-reference.usecommune.dev/operation/operation-getformdefaults.md)

- [Update the form defaults](https://api-reference.usecommune.dev/operation/operation-updateformdefaults.md)



## Insights

### [Engagement](https://api-reference.usecommune.dev/group/endpoint-engagement.md)

- [List a newsletter's subscriber insights](https://api-reference.usecommune.dev/operation/operation-listnewsletterinsights.md)

- [List a newsletter's engagement events](https://api-reference.usecommune.dev/operation/operation-listnewsletterevents.md)


### [Metrics](https://api-reference.usecommune.dev/group/endpoint-metrics.md)

- [Retrieve a newsletter's headline numbers](https://api-reference.usecommune.dev/operation/operation-getnewsletterstats.md)

- [Retrieve a newsletter's acquisition breakdown](https://api-reference.usecommune.dev/operation/operation-getnewslettergrowth.md)

- [Retrieve one newsletter metric bucketed over time](https://api-reference.usecommune.dev/operation/operation-getnewslettertimeseries.md)

- [Retrieve one article's performance](https://api-reference.usecommune.dev/operation/operation-getarticlestats.md)



## Sending and domains

### [Sends](https://api-reference.usecommune.dev/group/endpoint-sends.md)

- [List a newsletter's sends](https://api-reference.usecommune.dev/operation/operation-listnewslettersends.md)

- [Retrieve a send](https://api-reference.usecommune.dev/operation/operation-getsend.md)


### [Senders](https://api-reference.usecommune.dev/group/endpoint-senders.md)

- [List a newsletter's sending addresses](https://api-reference.usecommune.dev/operation/operation-listnewslettersenders.md)

- [Retrieve a sending address](https://api-reference.usecommune.dev/operation/operation-getsender.md)


### [Website domains](https://api-reference.usecommune.dev/group/endpoint-website-domains.md)

- [List a newsletter's website domains](https://api-reference.usecommune.dev/operation/operation-listnewsletterdomains.md)

- [Retrieve a website domain](https://api-reference.usecommune.dev/operation/operation-getdomain.md)

- [Change what a website domain serves](https://api-reference.usecommune.dev/operation/operation-updatedomain.md)


### [Automations](https://api-reference.usecommune.dev/group/endpoint-automations.md)

- [List a newsletter's automations](https://api-reference.usecommune.dev/operation/operation-listnewsletterautomations.md)

- [Create an automation](https://api-reference.usecommune.dev/operation/operation-createautomation.md)

- [List the events an automation can trigger on](https://api-reference.usecommune.dev/operation/operation-listautomationtriggers.md)

- [Retrieve an automation](https://api-reference.usecommune.dev/operation/operation-getautomation.md)

- [Archive an automation](https://api-reference.usecommune.dev/operation/operation-deleteautomation.md)

- [Update an automation](https://api-reference.usecommune.dev/operation/operation-updateautomation.md)

- [Turn an automation on](https://api-reference.usecommune.dev/operation/operation-activateautomation.md)

- [Turn an automation off](https://api-reference.usecommune.dev/operation/operation-pauseautomation.md)

- [List an automation's runs](https://api-reference.usecommune.dev/operation/operation-listautomationruns.md)

- [Send a test copy of one step's email](https://api-reference.usecommune.dev/operation/operation-sendautomationsteptest.md)

- [Retrieve an automation run](https://api-reference.usecommune.dev/operation/operation-getautomationrun.md)



## Creator websites

### [Creator websites](https://api-reference.usecommune.dev/group/endpoint-creator-websites.md)

- [List a newsletter's website pages](https://api-reference.usecommune.dev/operation/operation-listnewslettersitepages.md)

- [Create a website page](https://api-reference.usecommune.dev/operation/operation-createsitepage.md)

- [Retrieve a website page](https://api-reference.usecommune.dev/operation/operation-getsitepage.md)

- [Delete a website page](https://api-reference.usecommune.dev/operation/operation-deletesitepage.md)

- [Change a website page](https://api-reference.usecommune.dev/operation/operation-updatesitepage.md)

- [Publish a website page](https://api-reference.usecommune.dev/operation/operation-publishsitepage.md)

- [Unpublish a website page](https://api-reference.usecommune.dev/operation/operation-unpublishsitepage.md)

- [Store a website asset](https://api-reference.usecommune.dev/operation/operation-createsiteasset.md)

- [List a newsletter's publishable keys](https://api-reference.usecommune.dev/operation/operation-listnewsletterpublishablekeys.md)

- [Create a publishable key](https://api-reference.usecommune.dev/operation/operation-createpublishablekey.md)

- [Revoke a publishable key](https://api-reference.usecommune.dev/operation/operation-revokepublishablekey.md)

- [Rotate a publishable key](https://api-reference.usecommune.dev/operation/operation-rotatepublishablekey.md)



## Platform

### [Platform](https://api-reference.usecommune.dev/group/endpoint-platform.md)

- [Service status](https://api-reference.usecommune.dev/operation/operation-getstatus.md)

- [Retrieve the calling credential's rate limit state](https://api-reference.usecommune.dev/operation/operation-getratelimit.md)

- [What this credential may call](https://api-reference.usecommune.dev/operation/operation-getnewsletterentitlements.md)

- [List this newsletter's API keys](https://api-reference.usecommune.dev/operation/operation-listnewsletterapikeys.md)

- [Retrieve an API key](https://api-reference.usecommune.dev/operation/operation-getapikey.md)

- [Revoke an API key](https://api-reference.usecommune.dev/operation/operation-revokeapikey.md)


### [Event delivery](https://api-reference.usecommune.dev/group/endpoint-event-delivery.md)

- [List where a newsletter's events go](https://api-reference.usecommune.dev/operation/operation-listnewsletterdestinations.md)

- [List what was delivered where, and how it went](https://api-reference.usecommune.dev/operation/operation-listnewsletterdeliveryattempts.md)

- [Retrieve one delivery attempt](https://api-reference.usecommune.dev/operation/operation-getdeliveryattempt.md)

- [Send an event to a destination again](https://api-reference.usecommune.dev/operation/operation-replaydeliveryattempt.md)

- [Open the event delivery portal](https://api-reference.usecommune.dev/operation/operation-createportalsession.md)


### [Webhooks](https://api-reference.usecommune.dev/group/webhook-webhooks.md)

- [Article like added or removed](https://api-reference.usecommune.dev/operation/operation-onarticleliked.md)

- [Article published](https://api-reference.usecommune.dev/operation/operation-onarticlepublished.md)

- [Article read](https://api-reference.usecommune.dev/operation/operation-onarticleread.md)

- [Article scheduled](https://api-reference.usecommune.dev/operation/operation-onarticlescheduled.md)

- [Automation run completed](https://api-reference.usecommune.dev/operation/operation-onautomationruncompleted.md)

- [Automation run ended early](https://api-reference.usecommune.dev/operation/operation-onautomationrunexited.md)

- [Automation run started](https://api-reference.usecommune.dev/operation/operation-onautomationrunstarted.md)

- [Billing subscription state changed](https://api-reference.usecommune.dev/operation/operation-onbillingsubscriptionupdated.md)

- [Delivery bounced](https://api-reference.usecommune.dev/operation/operation-ondeliverybounced.md)

- [Delivery link clicked](https://api-reference.usecommune.dev/operation/operation-ondeliveryclicked.md)

- [Delivery marked as spam](https://api-reference.usecommune.dev/operation/operation-ondeliverycomplained.md)

- [Delivery accepted by the recipient server](https://api-reference.usecommune.dev/operation/operation-ondeliverydelivered.md)

- [Delivery opened](https://api-reference.usecommune.dev/operation/operation-ondeliveryopened.md)

- [Custom website domain verified](https://api-reference.usecommune.dev/operation/operation-ondomainverified.md)

- [Highlight created](https://api-reference.usecommune.dev/operation/operation-onhighlightcreated.md)

- [Import finished](https://api-reference.usecommune.dev/operation/operation-onimportcompleted.md)

- [Message created](https://api-reference.usecommune.dev/operation/operation-onmessagecreated.md)

- [Send completed](https://api-reference.usecommune.dev/operation/operation-onsendcompleted.md)

- [Send failed](https://api-reference.usecommune.dev/operation/operation-onsendfailed.md)

- [Sender verified](https://api-reference.usecommune.dev/operation/operation-onsenderverified.md)

- [Subscriber created](https://api-reference.usecommune.dev/operation/operation-onsubscribercreated.md)

- [Subscriber joined a form](https://api-reference.usecommune.dev/operation/operation-onsubscriberjoinedform.md)

- [Subscriber insight status changed](https://api-reference.usecommune.dev/operation/operation-onsubscriberstatuschanged.md)

- [Subscriber tag added or removed](https://api-reference.usecommune.dev/operation/operation-onsubscribertagged.md)

- [Subscriber unsubscribed](https://api-reference.usecommune.dev/operation/operation-onsubscriberunsubscribed.md)

- [Thread created](https://api-reference.usecommune.dev/operation/operation-onthreadcreated.md)

- [Thread published to the feed](https://api-reference.usecommune.dev/operation/operation-onthreadpublished.md)




## Changelog

- [Changelog](https://api-reference.usecommune.dev/changes.md)
- [Changelog index (llms.txt)](https://api-reference.usecommune.dev/changes/llms.txt)

[Powered by Bump.sh](https://bump.sh)
