Show more

Use to navigate results, ENTER to select one, ESC to close

Type in any word to easily find the endpoint, property or group of operations you are looking for.

API changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
Guides, getting started, authe...
REST API logo

Topics

  • Introduction
  • Authentications

Newsletters and people

  • Newsletters
    • List newsletters GET
    • Retrieve a newsletter GET
  • Team
    • List a newsletter's team GET
  • Users
    • Retrieve a user GET
    • List the newsletters a user publishes GET
    • List the newsletters a user reads GET
  • Search
    • Search Commune GET

Publishing

  • Articles
    • List a newsletter's articles GET
    • Retrieve an article GET
    • List an article's authors GET
  • Highlights
    • List an article's highlights GET
    • Retrieve a highlight GET

Community

  • Threads
    • List a newsletter's threads GET
    • Retrieve a thread GET
  • Messages
    • List a thread's messages GET
    • Retrieve a message GET
    • List a message's reactions GET

Audience

  • Subscribers
    • List a newsletter's subscribers GET
    • Retrieve a subscriber GET
  • Subscriber tags
    • List a newsletter's tags GET
    • Retrieve a tag GET

Insights

  • Engagement
    • List a newsletter's subscriber insights GET
    • List a newsletter's engagement events GET
  • Metrics
    • Retrieve a newsletter's headline numbers GET
    • Retrieve a newsletter's acquisition breakdown GET
    • Retrieve one newsletter metric bucketed over time GET
    • Retrieve one article's performance GET

Sending and domains

  • Senders
    • List a newsletter's sending addresses GET
    • Retrieve a sending address GET
  • Website domains
    • List a newsletter's website domains GET
    • Retrieve a website domain GET

Platform

  • Platform
    • Service status GET
    • Retrieve the calling key's rate limit state GET
  • Webhooks
    • Article published POST
    • Article scheduled POST
    • Billing subscription state changed POST
    • Delivery bounced POST
    • Delivery link clicked POST
    • Delivery marked as spam POST
    • Delivery accepted by the recipient server POST
    • Delivery opened POST
    • Custom website domain verified POST
    • Highlight created POST
    • Import finished POST
    • Message created POST
    • Send completed POST
    • Send failed POST
    • Sender verified POST
    • Subscriber created POST
    • Subscriber insight status changed POST
    • Subscriber tag added or removed POST
    • Subscriber unsubscribed POST
    • Thread created POST
    • Thread published to the feed POST
Powered by Bump.sh
API changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
Guides, getting started, authe...
REST API logo