Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

NationBuilder Mailings API

Referred to as email blasts, mailings send bulk emails to a group of signups at once. Mailings belong to and are sent via a broadcaster. The recipients of a mailing can be selected by lists, filters, or tags. Find more on how to use mailings [here](https://support.nationbuilder.com/en/articles/8077751-create-an-email-blast).

NationBuilder Mailings API is one of 41 APIs that NationBuilder publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Mailings. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 2 operations across 2 paths, and defines 15 schemas. It is described by OpenAPI 3.1.2, at version 2.0.

Requests are made against a single base URL, https://{subdomain}.nationbuilder.com.

2 operations 2 paths 15 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.2
API Version
2.0
Base URL
https://{nation-slug}.nationbuilder.com/api/v2
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

NationBuilder Mailings API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — Authentication using a bearer token (JWT) issued via OAuth.

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.

Mailings 2

Referred to as email blasts, mailings send bulk emails to a group of signups at once. Mailings belong to and are sent via a broadcaster. The recipients of a mailing can be selecte…

GET
/api/v2/mailings
List all mailings in a nation
listMailings 5 params → 200401429
GET
/api/v2/mailings/{id}
Show mailing with provided ID
showMailing 4 params → 200401404429

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are mailing_read_only_attributes (15 properties), pagination_links (5 properties), index_document (4 properties), show_document (3 properties). Each schema is shown below with its type and property counts.

error_response
object
The error body returned for 4xx and 5xx responses, with a machine-readable code and a human-readable message. Some errors include additional detail members alo…
2 properties 2 required
show_document
object
The JSON:API top-level document shape for responses returning a single resource under the data member.
3 properties 1 required
resource_identifier
object
A JSON:API resource identifier object, the type/id pair that uniquely identifies a single resource.
2 properties 2 required
mailing_read_only_attributes
object
The read-only attributes of a mailing.
15 properties
pagination_links
object
JSON:API pagination links for the pages of a collection. A key whose page is unavailable, or that the server's pagination strategy does not provide, is omitted…
5 properties
index_document
object
The JSON:API top-level document shape for paginated collection responses, with resource objects under data and pagination links.
4 properties 1 required
mailing_show_response
A JSON:API response containing a single mailing.
mailing_index_response
A paginated JSON:API response containing a list of mailings.
rate_limited_response
object
The body returned by the rate limiter when an access token exceeds its request quota.
1 property 1 required
mailing_response_data
The JSON:API resource object representing a mailing.
mailing_sideload_values
string
Relationship names that can be sideloaded with the include query parameter on mailing endpoints.
mailing_field_values
string
Readable mailing attribute names selectable with sparse fieldsets (fields[mailings]).
mailing_extra_field_values
string
Opt-in mailing attribute names requestable with extrafields[mailings].
resource
A generic JSON:API resource object. Resources sideloaded in a document's included member use this shape; their attributes are those of the resource type named…
included
array
Sideloaded resources requested via the include query parameter. Each entry is a full resource object whose shape is documented under its own resource type.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nationbuilder-mailings-api-openapi.yml Raw ↑

Other APIs NationBuilder publishes across the network.

NationBuilder Async Processes API
NationBuilder Automation Enrollments API
NationBuilder Automations API
NationBuilder Ballots API
NationBuilder Broadcasters API
NationBuilder Contacts API
NationBuilder Custom Fields API
NationBuilder Donation Tracking Codes API
NationBuilder Donations API
NationBuilder Elections API
NationBuilder Event Rsvps API
NationBuilder Event Ticket Levels API