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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Buttondown

Buttondown Events API

The Events API from Buttondown — 2 operation(s) covering the unified event store that also powers webhooks.

Documentation Provider Profile APIs.io OpenAPI GitHub

Buttondown Events API is one of 31 APIs that Buttondown publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Event. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.

This API exposes 2 operations across 2 paths, and defines 34 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

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

2 operations 2 paths 34 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.buttondown.com/v1
Authentication
API Key
License
MIT
Resource Areas
1

Authentication & Security 1

Buttondown Events API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — API key passed as 'Token ' in the Authorization header.

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.

Events 2
GET
/events
List Events
list_events 7 params → 200403409401429
GET
/events/{id}
Get Event
get_event 2 params → 200403404401429

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are Subscriber (47 properties), Email (27 properties), Analytics (20 properties), EmailEvent (10 properties). Each schema is shown below with its type and property counts.

FilterGroup
object
Buttondown's filtering schema can be used for multiple things: - Filtering [the audience of an email](/api-emails-create) to a specific subset - Creating [fine…
3 properties 3 required
EmailCommentingMode
string
Governs who can comment on this email. This enum replaces the iscommentsdisabled field, which has been deprecated. (Also note that this field may be superseded…
EmailEventPage
object
4 properties 2 required
AutomationStatus
string
An enumeration.
Filter
object
A filter is a single condition that can be evaluated against a [Subscriber](/api-subscribers-retrieve). It has a field, an operator, and a value: json { "field…
3 properties 3 required
Action
object
An action to perform when the automation's trigger fires.
3 properties 2 required
EmailStatus
string
Represents the state of an email. No action is required to move from one state or another; Buttondown internally handles the transitions, and exposing the stat…
Operator
string
An enumeration.
FirewallReasonCode
string
An enumeration.
Subscriber
object
Subscribers are the main way you collect email addresses and recipients on Buttondown. They're what you see on your [subscribers page](https://buttondown.com/s…
47 properties 11 required
Callout
string
Surfacing-time flags about an email that the UI uses to render contextual callouts (e.g. in the analytics panel). Computed on read; not persisted.
FailureBreakdownItem
object
A single failure reason with its count.
2 properties 2 required
NewsletterEmailTemplate
string
Represents the template of an email. Each template has a different layout/style; you can view screenshots and examples [in the docs](https://docs.buttondown.co…
Transition
object
2 properties 2 required
ArchivalMode
string
Governs who can view this email in the archive. ARCHIVEONLY is the odd one out: the email is publicly archived but is not email content at all (e.g. an importe…
FirewallReason
object
2 properties 2 required
EmailEvent
object
10 properties 4 required
Delay
object
Configuration for how long to wait before executing the automation's action.
3 properties 2 required
Analytics
object
20 properties
SubscriberType
string
Represents the state of a subscriber and what emails they should or should not be receiving. This type is meant to be fully expressive so as to consolidate the…
EmailSource
string
Represents the original provenance of an email. This value is not exposed to subscribers, but does determine some behavior of the email (e.g. whether or not an…
Email
object
Emails are why you're here on Buttondown, right? Creating an email via the API is just like creating one in the interface; it will instantly trigger sending ac…
27 properties 17 required
Timing
object
Controls when an automation's action executes after the trigger fires.
2 properties 1 required
EmailEventType
string
The type of a subscriber event, such as a delivery, open, click, or reply.
AutomationActionType
string
The action that is triggered when the automation is successfully run.
EmailSuppressionReason
string
Represents the reason an email was suppressed.
StripeCoupon
object
Coupons let you offer discounts to subscribers who pay for your newsletter. Buttondown's coupons are backed by Stripe, so each coupon maps to a coupon on your…
4 properties 1 required
EmailTransition
object
3 properties 2 required
EmailType
string
The legacy single-axis representation of an email's audience and archive visibility. No longer stored: filters owns the audience axis and archivalmode owns the…
ExternalEventType
string
Various types of events that are recorded by Buttondown, both in terms of exogenous systems like Stripe and Memberful, and endogenous ones like email opens and…
SubscriberUndeliverabilityReason
string
The reason Buttondown has marked the subscriber as undeliverable. Undeliverable subscribers are not sent emails, and may be periodically removed from the syste…
SubscriberSource
string
Represents the original provenance of a subscriber. This value is not exposed to subscribers; it's only used for internal tracking purposes and governs some of…
Automation
object
A rule that automatically performs actions in response to events.
9 properties 9 required
ErrorMessage
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

buttondown-events-api-openapi.yml Raw ↑

Other APIs Buttondown publishes across the network.

Buttondown Accounts API
AE Profile APIs.io
Buttondown Advertising Units API
AE Profile APIs.io
Buttondown API Requests API
AE Profile APIs.io
Buttondown Attachments API
AE Profile APIs.io
Buttondown Automations API
AE Profile APIs.io
Buttondown Books API
AE Profile APIs.io
Buttondown Bulk Actions API
AE Profile APIs.io
Buttondown Comments API
AE Profile APIs.io
Buttondown Coupons API
AE Profile APIs.io
Buttondown Emails API
AE Profile APIs.io
Buttondown Exports API
AE Profile APIs.io
Buttondown External Feeds API
AE Profile APIs.io
#Event
← Back to B APIs
API Details
ID
buttondown:buttondown-events-api
Base URL
https://api.buttondown.com/v1
Docs
https://docs.buttondown.com/api-events-retrieve
Provider
Buttondown
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

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.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=buttondown-events-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/buttondown-events-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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 Buttondown Events 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.