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 Async Processes API

This endpoint is used to get information about deferred or asynchronous processes returned by other endpoints such as adding and removing signups from a list or tagging and untagging signups from a list. Other endpoints in the future may use a deferred model as well.

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

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

This API exposes 1 operation across 1 path, and defines 2 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.

1 operations 1 paths 2 schemas 1 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 Async Processes 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 1

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

Async Processes 1

This endpoint is used to get information about deferred or asynchronous processes returned by other endpoints such as adding and removing signups from a list or tagging and untagg…

GET
/api/v2/async_processes/{id}
Show async process with provided token ID
showAsyncProcess 1 param → 200401404429

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are error_response (2 properties), rate_limited_response (1 property). 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
rate_limited_response
object
The body returned by the rate limiter when an access token exceeds its request quota.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nationbuilder-async-processes-api-openapi.yml Raw ↑

Other APIs NationBuilder publishes across the network.

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
NationBuilder Events API