NationBuilder is a community-engagement and organizing platform for political campaigns, advocacy groups, nonprofits, and membership organizations, pairing a supporter CRM with a website/page builder, email and text messaging, event and petition tools, and integrated fundraising. Its developer surface is a REST API offered in two flavors: the current v2 API, which follows the JSON:API specification and authenticates with OAuth 2.0 (authorization-code with optional PKCE and refresh tokens), and a legacy v1 API that uses per-nation API tokens. The API exposes people/signups, donations, events, petitions, memberships, lists, tags, and related resources so integrators can sync supporter data and automate outreach. NationBuilder is multi-tenant: each nation is reached at its own {nation-slug}.nationbuilder.com host.
NationBuilder publishes 41 APIs on the APIs.io network, including Async Processes API, Automation Enrollments API, Automations API, and 38 more. Tagged areas include Community Organizing, CRM, Political, Nonprofit, and Fundraising.
NationBuilder’s developer surface includes documentation, getting-started guide, support, engineering blog, pricing, signup flow, changelog, and 22 more developer resources.
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 unta...
AutomationEnrollments link signups to automations. Every AutomationEnrollment belongs to a single Signup and a single Automation. Further information on how signups are enrolled...
Automations represent workflows where chains of actions and reactions can be created within a nation. Signups can be enrolled in an automation and are represented via the Automa...
Ballots are a record of an election and how a person voted for said election. Each ballot is associated with a voter and an election and contains information such as when the ba...
Contacts are logged interactions between people in your nation. More information about contacts and the fields found in the UI and API interfaces can be found [here](https://sup...
Custom fields are available for Signups and Donations. See [here](https://support.nationbuilder.com/en/articles/2340612-introduction-to-custom-fields) for more information.
Tracking codes are used to identify where a financial transaction came from. Users give the tracking code a custom name/slug and use the code to track where a donation was made....
Currently we allow you to record existing donation transactions via API V2. These transactions will not be backed by any kind of financial transaction. See the [docs](https://su...
Elections are available on nations with voter features enabled. See more information about election functionality [here](https://support.nationbuilder.com/en/articles/2362732-se...
This resource is for creating, reading, updating, and deleting Event RSVPs. When creating event RSVPs, the rsvp must be given signup data, either by passing a first name, last n...
This resource is for creating, reading, updating, and deleting ticket levels for events. manage the ticket levels available for the events. Ticket levels and their prices are di...
Resource used for managing event data associated with event pages. More details on events within NationBuilder can be found [here](https://support.nationbuilder.com/en/articles/...
All kinds of data can be imported into a nation, when this happens we create an import resource as a record of the imported data. Each import has a type attribute defining the k...
Lists are collections of signups. Often created from filters they are useful for grouping signups together by common attributes. They can be used to perform batch updates on sig...
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 selec...
Membership types are used to identify memberships assigned to signups. A membership type has many memberships which are assigned a single signup. The only required attribute for...
A membership is a way to organize supporters and provide additional benefits based on actions they've taken or money donated. More information about memberships and the fields f...
Pages are published on your site. Each page type offers different features, you can view them [here](https://support.nationbuilder.com/en/articles/2319593-types-of-nationbuilder...
Path journeys are the relationship between signups and paths. Further information available [here](https://support.nationbuilder.com/en/articles/3055899-create-paths#create-a-pa...
Path steps name the positions within a path a signup can be assigned to. Further information available [here](https://support.nationbuilder.com/en/articles/3055899-create-paths#...
Paths store information about path journeys and steps. They are related to signups via path journeys. A path can be assigned many path journeys and path steps. Further informati...
Petitions are pages on your site that can be signed and shared by your supporters. Learn more about them [here](https://support.nationbuilder.com/en/articles/2327303-create-a-pe...
Pledges are a promise from a signup to donate to your cause. These are not donations. Further information available [here](https://support.nationbuilder.com/en/articles/2344197-...
Precincts are districts used by political campaigns. Read more about them [here](https://support.nationbuilder.com/en/articles/2471652-creating-and-viewing-political-precincts).
Profile information for a signup that can be displayed on a public site page. Read more on public profiles [here](https://support.nationbuilder.com/en/articles/2327657-how-publi...
Tags are used to quickly identify signups by certain characteristics. They are related to signups through SignupTaggings. Read more about them [here](https://support.nationbuild...
Signups store information about people in your nation. Further information available [here](https://support.nationbuilder.com/en/articles/8810042-how-records-are-added-to-the-pe...
A site is how supporters interact with your nation. Each site has a theme and many pages that can be drafted and published later to be viewed publicly. Read more about sites [he...
Suggestion boxes are containers for collecting suggestions from your community. They live on website pages, and define the settings, auto-responses, categorization tags, and mod...
Suggestions are individual ideas or proposals submitted to suggestion boxes on your site. They can be responded to, categorized, and managed by administrators. **Responding to S...
aid: nationbuilder
accessModel:
pricing: unknown
onboarding: self-serve
trial: false
try_now: false
public: false
label: Self-serve signup
confidence: medium
source:
- authentication
generated: '2026-07-22'
method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/nationbuilder.png
name: NationBuilder
description: 'NationBuilder is a community-engagement and organizing platform for political campaigns, advocacy groups, nonprofits,
and membership organizations, pairing a supporter CRM with a website/page builder, email and text messaging, event and petition
tools, and integrated fundraising. Its developer surface is a REST API offered in two flavors: the current v2 API, which
follows the JSON:API specification and authenticates with OAuth 2.0 (authorization-code with optional PKCE and refresh tokens),
and a legacy v1 API that uses per-nation API tokens. The API exposes people/signups, donations, events, petitions, memberships,
lists, tags, and related resources so integrators can sync supporter data and automate outreach. NationBuilder is multi-tenant:
each nation is reached at its own {nation-slug}.nationbuilder.com host.'
url: https://raw.githubusercontent.com/api-evangelist/nationbuilder/refs/heads/main/apis.yml
x-type: company
x-source: vc-portfolio
x-backed-by:
- a16z
- slow-ventures
x-tier: stub
x-tier-reason: portfolio-lead
specificationVersion: '0.20'
created: '2026-07-17'
modified: '2026-07-20'
tags:
- Community Organizing
- CRM
- Political
- Nonprofit
- Fundraising
- Advocacy
- Website Builder
- Events
- Email
- JSON:API
apis:
- aid: nationbuilder:nationbuilder-async-processes-api
name: NationBuilder Async Processes API
description: 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.
humanURL: https://support.nationbuilder.com/en/collections/10408291-api
baseURL: https://{nation-slug}.nationbuilder.com/api/v2
tags:
- Async Processes
properties:
- type: OpenAPI
url: openapi/nationbuilder-async-processes-api-openapi.yml
- type: InteractiveDocs
url: https://nationbuilder.com/api/v2/reference
- type: Documentation
url: https://support.nationbuilder.com/en/collections/10408291-api
- type: APIReference
url: https://support.nationbuilder.com/en/articles/10857983-interactive-api-documentation-endpoint-explorer
- type: GettingStarted
url: https://support.nationbuilder.com/en/articles/9869274-nationbuilder-api-quickstart-guide
- aid: nationbuilder:nationbuilder-automation-enrollments-api
name: NationBuilder Automation Enrollments API
description: AutomationEnrollments link signups to automations. Every AutomationEnrollment belongs to a single Signup and
a single Automation. Further information on how signups are enrolled in automations is available [here](https://support.nationbuilder.com/en/articles/6680735-create-an-automation#h_2783ee4e5c).
humanURL: https://support.nationbuilder.com/en/collections/10408291-api
baseURL: https://{nation-slug}.nationbuilder.com/api/v2
tags:
- Automation Enrollments
properties:
- type: OpenAPI
url: openapi/nationbuilder-automation-enrollments-api-openapi.yml
- type: InteractiveDocs
url: https://nationbuilder.com/api/v2/reference
- type: Documentation
url: https://support.nationbuilder.com/en/collections/10408291-api
- type: APIReference
url: https://support.nationbuilder.com/en/articles/10857983-interactive-api-documentation-endpoint-explorer
- type: GettingStarted
url: https://support.nationbuilder.com/en/articles/9869274-nationbuilder-api-quickstart-guide
- aid: nationbuilder:nationbuilder-automations-api
name: NationBuilder Automations API
description: Automations represent workflows where chains of actions and reactions can be created within a nation. Signups
can be enrolled in an automation and are represented via the AutomationEnrollments resource. Further information available
[here](https://support.nationbuilder.com/en/articles/6680735-create-an-automation).
humanURL: https://support.nationbuilder.com/en/collections/10408291-api
baseURL: https://{nation-slug}.nationbuilder.com/api/v2
tags:
- Automations
properties:
- type: OpenAPI
url: openapi/nationbuilder-automations-api-openapi.yml
- type: InteractiveDocs
url: https://nationbuilder.com/api/v2/reference
- type: Documentation
url: https://support.nationbuilder.com/en/collections/10408291-api
- type: APIReference
url: https://support.nationbuilder.com/en/articles/10857983-interactive-api-documentation-endpoint-explorer
- type: GettingStarted
url: https://support.nationbuilder.com/en/articles/9869274-nationbuilder-api-quickstart-guide
- aid: nationbuilder:nationbuilder-ballots-api
name: NationBuilder Ballots API
description: Ballots are a record of an election and how a person voted for said election. Each ballot is associated with
a voter and an election and contains information such as when the ballot was cast, the party, and vote method. Further
information about vote history and ballots available [here](https://support.nationbuilder.com/en/articles/2471330-import-vote-history).
humanURL: https://support.nationbuilder.com/en/collections/10408291-api
baseURL: https://{nation-slug}.nationbuilder.com/api/v2
tags:
- Ballots
properties:
- type: OpenAPI
url: openapi/nationbuilder-ballots-api-openapi.yml
- type: InteractiveDocs
url: https://nationbuilder.com/api/v2/reference
- type: Documentation
url: https://support.nationbuilder.com/en/collections/10408291-api
- type: APIReference
url: https://support.nationbuilder.com/en/articles/10857983-interactive-api-documentation-endpoint-explorer
- type: GettingStarted
url: https://support.nationbuilder.com/en/articles/9869274-nationbuilder-api-quickstart-guide
- aid: nationbuilder:nationbuilder-broadcasters-api
name: NationBuilder Broadcasters API
description: Broadcasters are the voices who speak publicly on behalf of your nation. All external communications are organized
around broadcasters.
humanURL: https://support.nationbuilder.com/en/collections/10408291-api
baseURL: https://{nation-slug}.nationbuilder.com/api/v2
tags:
- Broadcasters
properties:
- type: OpenAPI
url: openapi/nationbuilder-broadcasters-api-openapi.yml
- type: InteractiveDocs
url: https://nationbuilder.com/api/v2/reference
- type: Documentation
url: https://support.nationbuilder.com/en/collections/10408291-api
- type: APIReference
url: https://support.nationbuilder.com/en/articles/10857983-interactive-api-documentation-endpoint-explorer
- type: GettingStarted
url: https://support.nationbuilder.com/en/articles/9869274-nationbuilder-api-quickstart-guide
- aid: nationbuilder:nationbuilder-contacts-api
name: NationBuilder Contacts API
description: 'Contacts are logged interactions between people in your nation. More information about contacts and the fields
found in the
UI and API interfaces can be found [here](https://support.nationbuilder.com/en/articles/2306309-logging-contacts).'
humanURL: https://support.nationbuilder.com/en/collections/10408291-api
baseURL: https://{nation-slug}.nationbuilder.com/api/v2
tags:
- Contacts
properties:
- type: OpenAPI
url: openapi/nationbuilder-contacts-api-openapi.yml
- type: InteractiveDocs
url: https://nationbuilder.com/api/v2/reference
- type: Documentation
url: https://support.nationbuilder.com/en/collections/10408291-api
- type: APIReference
url: https://support.nationbuilder.com/en/articles/10857983-interactive-api-documentation-endpoint-explorer
- type: GettingStarted
url: https://support.nationbuilder.com/en/articles/9869274-nationbuilder-api-quickstart-guide
- aid: nationbuilder:nationbuilder-custom-fields-api
name: NationBuilder Custom Fields API
description: Custom fields are available for Signups and Donations. See [here](https://support.nationbuilder.com/en/articles/2340612-introduction-to-custom-fields)
for more information.
humanURL: https://support.nationbuilder.com/en/collections/10408291-api
baseURL: https://{nation-slug}.nationbuilder.com/api/v2
tags:
- Custom Fields
properties:
- type: OpenAPI
url: openapi/nationbuilder-custom-fields-api-openapi.yml
- type: InteractiveDocs
url: https://nationbuilder.com/api/v2/reference
- type: Documentation
url: https://support.nationbuilder.com/en/collections/10408291-api
- type: APIReference
url: https://support.nationbuilder.com/en/articles/10857983-interactive-api-documentation-endpoint-explorer
- type: GettingStarted
url: https://support.nationbuilder.com/en/articles/9869274-nationbuilder-api-quickstart-guide
- aid: nationbuilder:nationbuilder-donation-tracking-codes-api
name: NationBuilder Donation Tracking Codes API
description: Tracking codes are used to identify where a financial transaction came from. Users give the tracking code a
custom name/slug and use the code to track where a donation was made. Read more about them [here](https://support.nationbuilder.com/en/articles/2344337-understanding-tracking-codes).
humanURL: https://support.nationbuilder.com/en/collections/10408291-api
baseURL: https://{nation-slug}.nationbuilder.com/api/v2
tags:
- Donation Tracking Codes
properties:
- type: OpenAPI
url: openapi/nationbuilder-donation-tracking-codes-api-openapi.yml
- type: InteractiveDocs
url: https://nationbuilder.com/api/v2/reference
- type: Documentation
url: https://support.nationbuilder.com/en/collections/10408291-api
- type: APIReference
url: https://support.nationbuilder.com/en/articles/10857983-interactive-api-documentation-endpoint-explorer
- type: GettingStarted
url: https://support.nationbuilder.com/en/articles/9869274-nationbuilder-api-quickstart-guide
- aid: nationbuilder:nationbuilder-donations-api
name: NationBuilder Donations API
description: 'Currently we allow you to record existing donation transactions via API V2. These transactions will not be
backed by any kind of financial transaction.
See the [docs](https://support.nationbuilder.com/en/articles/2344242-create-or-record-an-individual-donation) for more
information.
If associated with an existing signup, the first_name, middle_name, and last_name associated with the donation will be
updated on the signup as well.
If the email is different than the primary email existing on the signup, it will be added to the signup''s email2, email3,
or email4 instead.'
humanURL: https://support.nationbuilder.com/en/collections/10408291-api
baseURL: https://{nation-slug}.nationbuilder.com/api/v2
tags:
- Donations
properties:
- type: OpenAPI
url: openapi/nationbuilder-donations-api-openapi.yml
- type: InteractiveDocs
url: https://nationbuilder.com/api/v2/reference
- type: Documentation
url: https://support.nationbuilder.com/en/collections/10408291-api
- type: APIReference
url: https://support.nationbuilder.com/en/articles/10857983-interactive-api-documentation-endpoint-explorer
- type: GettingStarted
url: https://support.nationbuilder.com/en/articles/9869274-nationbuilder-api-quickstart-guide
- aid: nationbuilder:nationbuilder-elections-api
name: NationBuilder Elections API
description: Elections are available on nations with voter features enabled. See more information about election functionality
[here](https://support.nationbuilder.com/en/articles/2362732-set-up-your-election)
humanURL: https://support.nationbuilder.com/en/collections/10408291-api
baseURL: https://{nation-slug}.nationbuilder.com/api/v2
tags:
- Elections
properties:
- type: OpenAPI
url: openapi/nationbuilder-elections-api-openapi.yml
- type: InteractiveDocs
url: https://nationbuilder.com/api/v2/reference
- type: Documentation
url: https://support.nationbuilder.com/en/collections/10408291-api
- type: APIReference
url: https://support.nationbuilder.com/en/articles/10857983-interactive-api-documentation-endpoint-explorer
- type: GettingStarted
url: https://support.nationbuilder.com/en/articles/9869274-nationbuilder-api-quickstart-guide
- aid: nationbuilder:nationbuilder-event-rsvps-api
name: NationBuilder Event Rsvps API
description: This resource is for creating, reading, updating, and deleting Event RSVPs. When creating event RSVPs, the
rsvp must be given signup data, either by passing a first name, last name, and email or phone number, or by sideposting
a signup.
humanURL: https://support.nationbuilder.com/en/collections/10408291-api
baseURL: https://{nation-slug}.nationbuilder.com/api/v2
tags:
- Event Rsvps
properties:
- type: OpenAPI
url: openapi/nationbuilder-event-rsvps-api-openapi.yml
- type: InteractiveDocs
url: https://nationbuilder.com/api/v2/reference
- type: Documentation
url: https://support.nationbuilder.com/en/collections/10408291-api
- type: APIReference
url: https://support.nationbuilder.com/en/articles/10857983-interactive-api-documentation-endpoint-explorer
- type: GettingStarted
url: https://support.nationbuilder.com/en/articles/9869274-nationbuilder-api-quickstart-guide
- aid: nationbuilder:nationbuilder-event-ticket-levels-api
name: NationBuilder Event Ticket Levels API
description: This resource is for creating, reading, updating, and deleting ticket levels for events. manage the ticket
levels available for the events. Ticket levels and their prices are displayed on public events. More information on ticketed
events in NationBuilder can be found [here](https://support.nationbuilder.com/en/articles/2319673-setting-up-an-event#ticketed-events)
humanURL: https://support.nationbuilder.com/en/collections/10408291-api
baseURL: https://{nation-slug}.nationbuilder.com/api/v2
tags:
- Event Ticket Levels
properties:
- type: OpenAPI
url: openapi/nationbuilder-event-ticket-levels-api-openapi.yml
- type: InteractiveDocs
url: https://nationbuilder.com/api/v2/reference
- type: Documentation
url: https://support.nationbuilder.com/en/collections/10408291-api
- type: APIReference
url: https://support.nationbuilder.com/en/articles/10857983-interactive-api-documentation-endpoint-explorer
- type: GettingStarted
url: https://support.nationbuilder.com/en/articles/9869274-nationbuilder-api-quickstart-guide
- aid: nationbuilder:nationbuilder-events-api
name: NationBuilder Events API
description: Resource used for managing event data associated with event pages. More details on events within NationBuilder
can be found [here](https://support.nationbuilder.com/en/articles/2319673-setting-up-an-event)
humanURL: https://support.nationbuilder.com/en/collections/10408291-api
baseURL: https://{nation-slug}.nationbuilder.com/api/v2
tags:
- Events
properties:
- type: OpenAPI
url: openapi/nationbuilder-events-api-openapi.yml
- type: InteractiveDocs
url: https://nationbuilder.com/api/v2/reference
- type: Documentation
url: https://support.nationbuilder.com/en/collections/10408291-api
- type: APIReference
url: https://support.nationbuilder.com/en/articles/10857983-interactive-api-documentation-endpoint-explorer
- type: GettingStarted
url: https://support.nationbuilder.com/en/articles/9869274-nationbuilder-api-quickstart-guide
- aid: nationbuilder:nationbuilder-imports-api
name: NationBuilder Imports API
description: All kinds of data can be imported into a nation, when this happens we create an import resource as a record
of the imported data. Each import has a type attribute defining the kind of data being imported. Find more information
on imports and import types [here](https://support.nationbuilder.com/en/articles/2309526-types-of-imports). This version
of the imports API does not currently support creating or archiving imports. Please use the v1 Imports API for this functionality
[here](https://nationbuilder.com/imports_api).
humanURL: https://support.nationbuilder.com/en/collections/10408291-api
baseURL: https://{nation-slug}.nationbuilder.com/api/v2
tags:
- Imports
properties:
- type: OpenAPI
url: openapi/nationbuilder-imports-api-openapi.yml
- type: InteractiveDocs
url: https://nationbuilder.com/api/v2/reference
- type: Documentation
url: https://support.nationbuilder.com/en/collections/10408291-api
- type: APIReference
url: https://support.nationbuilder.com/en/articles/10857983-interactive-api-documentation-endpoint-explorer
- type: GettingStarted
url: https://support.nationbuilder.com/en/articles/9869274-nationbuilder-api-quickstart-guide
- aid: nationbuilder:nationbuilder-lists-api
name: NationBuilder Lists API
description: Lists are collections of signups. Often created from filters they are useful for grouping signups together
by common attributes. They can be used to perform batch updates on signups or as a list of recipients for a mailing blast.
Read more on what you can do with lists [here](https://support.nationbuilder.com/en/articles/2305947-create-a-list).
humanURL: https://support.nationbuilder.com/en/collections/10408291-api
baseURL: https://{nation-slug}.nationbuilder.com/api/v2
tags:
- Lists
properties:
- type: OpenAPI
url: openapi/nationbuilder-lists-api-openapi.yml
- type: InteractiveDocs
url: https://nationbuilder.com/api/v2/reference
- type: Documentation
url: https://support.nationbuilder.com/en/collections/10408291-api
- type: APIReference
url: https://support.nationbuilder.com/en/articles/10857983-interactive-api-documentation-endpoint-explorer
- type: GettingStarted
url: https://support.nationbuilder.com/en/articles/9869274-nationbuilder-api-quickstart-guide
- aid: nationbuilder:nationbuilder-mailings-api
name: NationBuilder Mailings API
description: 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).
humanURL: https://support.nationbuilder.com/en/collections/10408291-api
baseURL: https://{nation-slug}.nationbuilder.com/api/v2
tags:
- Mailings
properties:
- type: OpenAPI
url: openapi/nationbuilder-mailings-api-openapi.yml
- type: InteractiveDocs
url: https://nationbuilder.com/api/v2/reference
- type: Documentation
url: https://support.nationbuilder.com/en/collections/10408291-api
- type: APIReference
url: https://support.nationbuilder.com/en/articles/10857983-interactive-api-documentation-endpoint-explorer
- type: GettingStarted
url: https://support.nationbuilder.com/en/articles/9869274-nationbuilder-api-quickstart-guide
- aid: nationbuilder:nationbuilder-membership-types-api
name: NationBuilder Membership Types API
description: Membership types are used to identify memberships assigned to signups. A membership type has many memberships
which are assigned a single signup. The only required attribute for the membership type is a name, then signups can be
given memberships with the newly created type. Read more on membership types [here](https://support.nationbuilder.com/en/articles/2362753-set-up-memberships#create-a-new-membership-type).
humanURL: https://support.nationbuilder.com/en/collections/10408291-api
baseURL: https://{nation-slug}.nationbuilder.com/api/v2
tags:
- Membership Types
properties:
- type: OpenAPI
url: openapi/nationbuilder-membership-types-api-openapi.yml
- type: InteractiveDocs
url: https://nationbuilder.com/api/v2/reference
- type: Documentation
url: https://support.nationbuilder.com/en/collections/10408291-api
- type: APIReference
url: https://support.nationbuilder.com/en/articles/10857983-interactive-api-documentation-endpoint-explorer
- type: GettingStarted
url: https://support.nationbuilder.com/en/articles/9869274-nationbuilder-api-quickstart-guide
- aid: nationbuilder:nationbuilder-memberships-api
name: NationBuilder Memberships API
description: 'A membership is a way to organize supporters and provide additional benefits based on actions they''ve taken
or money donated.
More information about memberships and the fields found in the UI and API interfaces can be found [here](https://support.nationbuilder.com/en/articles/2362753-set-up-memberships)
By default, autoresponses when updating a membership are not triggered. Set the `trigger_autoresponses` param to `true`
to trigger autoresponses on update.'
humanURL: https://support.nationbuilder.com/en/collections/10408291-api
baseURL: https://{nation-slug}.nationbuilder.com/api/v2
tags:
- Memberships
properties:
- type: OpenAPI
url: openapi/nationbuilder-memberships-api-openapi.yml
- type: InteractiveDocs
url: https://nationbuilder.com/api/v2/reference
- type: Documentation
url: https://support.nationbuilder.com/en/collections/10408291-api
- type: APIReference
url: https://support.nationbuilder.com/en/articles/10857983-interactive-api-documentation-endpoint-explorer
- type: GettingStarted
url: https://support.nationbuilder.com/en/articles/9869274-nationbuilder-api-quickstart-guide
- aid: nationbuilder:nationbuilder-pages-api
name: NationBuilder Pages API
description: Pages are published on your site. Each page type offers different features, you can view them [here](https://support.nationbuilder.com/en/articles/2319593-types-of-nationbuilder-pages).
humanURL: https://support.nationbuilder.com/en/collections/10408291-api
baseURL: https://{nation-slug}.nationbuilder.com/api/v2
tags:
- Pages
properties:
- type: OpenAPI
url: openapi/nationbuilder-pages-api-openapi.yml
- type: InteractiveDocs
url: https://nationbuilder.com/api/v2/reference
- type: Documentation
url: https://support.nationbuilder.com/en/collections/10408291-api
- type: APIReference
url: https://support.nationbuilder.com/en/articles/10857983-interactive-api-documentation-endpoint-explorer
- type: GettingStarted
url: https://support.nationbuilder.com/en/articles/9869274-nationbuilder-api-quickstart-guide
- aid: nationbuilder:nationbuilder-path-histories-api
name: NationBuilder Path Histories API
description: Documents a signup's step along a path journey.
humanURL: https://support.nationbuilder.com/en/collections/10408291-api
baseURL: https://{nation-slug}.nationbuilder.com/api/v2
tags:
- Path Histories
properties:
- type: OpenAPI
url: openapi/nationbuilder-path-histories-api-openapi.yml
- type: InteractiveDocs
url: https://nationbuilder.com/api/v2/reference
- type: Documentation
url: https://support.nationbuilder.com/en/collections/10408291-api
- type: APIReference
url: https://support.nationbuilder.com/en/articles/10857983-interactive-api-documentation-endpoint-explorer
- type: GettingStarted
url: https://support.nationbuilder.com/en/articles/9869274-nationbuilder-api-quickstart-guide
- aid: nationbuilder:nationbuilder-path-journey-status-changes-api
name: NationBuilder Path Journey Status Changes API
description: Documents the status change of a path journey.
humanURL: https://support.nationbuilder.com/en/collections/10408291-api
baseURL: https://{nation-slug}.nationbuilder.com/api/v2
tags:
- Path Journey Status Changes
properties:
- type: OpenAPI
url: openapi/nationbuilder-path-journey-status-changes-api-openapi.yml
- type: InteractiveDocs
url: https://nationbuilder.com/api/v2/reference
- type: Documentation
url: https://support.nationbuilder.com/en/collections/10408291-api
- type: APIReference
url: https://support.nationbuilder.com/en/articles/10857983-interactive-api-documentation-endpoint-explorer
- type: GettingStarted
url: https://support.nationbuilder.com/en/articles/9869274-nationbuilder-api-quickstart-guide
- aid: nationbuilder:nationbuilder-path-journeys-api
name: NationBuilder Path Journeys API
description: Path journeys are the relationship between signups and paths. Further information available [here](https://support.nationbuilder.com/en/articles/3055899-create-paths#create-a-path).
humanURL: https://support.nationbuilder.com/en/collections/10408291-api
baseURL: https://{nation-slug}.nationbuilder.com/api/v2
tags:
- Path Journeys
properties:
- type: OpenAPI
url: openapi/nationbuilder-path-journeys-api-openapi.yml
- type: InteractiveDocs
url: https://nationbuilder.com/api/v2/reference
- type: Documentation
url: https://support.nationbuilder.com/en/collections/10408291-api
- type: APIReference
url: https://support.nationbuilder.com/en/articles/10857983-interactive-api-documentation-endpoint-explorer
- type: GettingStarted
url: https://support.nationbuilder.com/en/articles/9869274-nationbuilder-api-quickstart-guide
- aid: nationbuilder:nationbuilder-path-steps-api
name: NationBuilder Path Steps API
description: Path steps name the positions within a path a signup can be assigned to. Further information available [here](https://support.nationbuilder.com/en/articles/3055899-create-paths#add-steps-to-the-path)
humanURL: https://support.nationbuilder.com/en/collections/10408291-api
baseURL: https://{nation-slug}.nationbuilder.com/api/v2
tags:
- Path Steps
properties:
- type: OpenAPI
url: openapi/nationbuilder-path-steps-api-openapi.yml
- type: InteractiveDocs
url: https://nationbuilder.com/api/v2/reference
- type: Documentation
url: https://support.nationbuilder.com/en/collections/10408291-api
- type: APIReference
url: https://support.nationbuilder.com/en/articles/10857983-interactive-api-documentation-endpoint-explorer
- type: GettingStarted
url: https://support.nationbuilder.com/en/articles/9869274-nationbuilder-api-quickstart-guide
- aid: nationbuilder:nationbuilder-paths-api
name: NationBuilder Paths API
description: Paths store information about path journeys and steps. They are related to signups via path journeys. A path
can be assigned many path journeys and path steps. Further information available [here](https://support.nationbuilder.com/en/articles/3055899-create-paths).
humanURL: https://support.nationbuilder.com/en/collections/10408291-api
baseURL: https://{nation-slug}.nationbuilder.com/api/v2
tags:
- Paths
properties:
- type: OpenAPI
url: openapi/nationbuilder-paths-api-openapi.yml
- type: InteractiveDocs
url: https://nationbuilder.com/api/v2/reference
- type: Documentation
url: https://support.nationbuilder.com/en/collections/10408291-api
- type: APIReference
url: https://support.nationbuilder.com/en/articles/10857983-interactive-api-documentation-endpoint-explorer
- type: GettingStarted
url: https://support.nationbuilder.com/en/articles/9869274-nationbuilder-api-quickstart-guide
- aid: nationbuilder:nationbuilder-petition-signatures-api
name: NationBuilder Petition Signatures API
description: Petition signatures are the relationship between petitions and signups.
humanURL: https://support.nationbuilder.com/en/collections/10408291-api
baseURL: https://{nation-slug}.nationbuilder.com/api/v2
tags:
- Petition Signatures
properties:
- type: OpenAPI
url: openapi/nationbuilder-petition-signatures-api-openapi.yml
- type: InteractiveDocs
url: https://nationbuilder.com/api/v2/reference
- type: Documentation
url: https://support.nationbuilder.com/en/collections/10408291-api
- type: APIReference
url: https://support.nationbuilder.com/en/articles/10857983-interactive-api-documentation-endpoint-explorer
- type: GettingStarted
url: https://support.nationbuilder.com/en/articles/9869274-nationbuilder-api-quickstart-guide
- aid: nationbuilder:nationbuilder-petitions-api
name: NationBuilder Petitions API
description: Petitions are pages on your site that can be signed and shared by your supporters. Learn more about them [here](https://support.nationbuilder.com/en/articles/2327303-create-a-petition).
humanURL: https://support.nationbuilder.com/en/collections/10408291-api
baseURL: https://{nation-slug}.nationbuilder.com/api/v2
tags:
- Petitions
properties:
- type: OpenAPI
url: openapi/nationbuilder-petitions-api-openapi.yml
- type: InteractiveDocs
url: https://nationbuilder.com/api/v2/reference
- type: Documentation
url: https://support.nationbuilder.com/en/collections/10408291-api
- type: APIReference
url: https://support.nationbuilder.com/en/articles/10857983-interactive-api-documentation-endpoint-explorer
- type: GettingStarted
url: https://support.nationbuilder.com/en/articles/9869274-nationbuilder-api-quickstart-guide
- aid: nationbuilder:nationbuilder-pledges-api
name: NationBuilder Pledges API
description: Pledges are a promise from a signup to donate to your cause. These are not donations. Further information available
[here](https://support.nationbuilder.com/en/articles/2344197-fundraising-with-nationbuilder).
humanURL: https://support.nationbuilder.com/en/collections/10408291-api
baseURL: https://{nation-slug}.nationbuilder.com/api/v2
tags:
- Pledges
properties:
- type: OpenAPI
url: openapi/nationbuilder-pledges-api-openapi.yml
- type: InteractiveDocs
url: https://nationbuilder.com/api/v2/reference
- type: Documentation
url: https://support.nationbuilder.com/en/collections/10408291-api
- type: APIReference
url: https://support.nationbuilder.com/en/articles/10857983-interactive-api-documentation-endpoint-explorer
- type: GettingStarted
url: https://support.nationbuilder.com/en/articles/9869274-nationbuilder-api-quickstart-guide
- aid: nationbuilder:nationbuilder-precincts-api
name: NationBuilder Precincts API
description: Precincts are districts used by political campaigns. Read more about them [here](https://support.nationbuilder.com/en/articles/2471652-creating-and-viewing-political-precincts).
humanURL: https://support.nationbuilder.com/en/collections/10408291-api
baseURL: https://{nation-slug}.nationbuilder.com/api/v2
tags:
- Precincts
properties:
- type: OpenAPI
url: openapi/nationbuilder-precincts-api-openapi.yml
- type: InteractiveDocs
url: https://nationbuilder.com/api/v2/reference
- type: Documentation
url: https://support.nationbuilder.com/en/collections/10408291-api
- type: APIReference
url: https://support.nationbuilder.com/en/articles/10857983-interactive-api-documentation-endpoint-explorer
- type: GettingStarted
url: https://support.nationbuilder.com/en/articles/9869274-nationbuilder-api-quickstart-guide
- aid: nationbuilder:nationbuilder-relationships-api
name: NationBuilder Relationships API
description: Valid relationship types are ["affiliate-affiliate", "alum-school", "assistant-assisted", "board_member-organization",
"candidate-committee", "chapter-parent", "child-parent", "consultant-organization", "employee-employer", "family_partner-family_partner",
"friend-friend", "member-organization", "mentee-mentor", "partner-partner", "primary_contact-organization", "relative-relative",
"representative-constituent", "resident-organization", "sibling-sibling", "spouse-spouse", "student-school", "student-teacher",
"subordinate-manager", "subsidiary-parent", "treasurer-committee"]. first_signup_id corresponds with the ID of the signup
on the first role listed, and second_signup_id corresponds with the ID of the signup on the second role listed in the
relationship type."
humanURL: https://support.nationbuilder.com/en/collections/10408291-api
baseURL: https://{nation-slug}.nationbuilder.com/api/v2
tags:
- Relationships
properties:
- type: OpenAPI
url: openapi/nationbuilder-relationships-api-openapi.yml
- type: InteractiveDocs
url: https://nationbuilder.com/api/v2/reference
- type: Documentation
url: https://support.nationbuilder.com/en/collections/10408291-api
- type: APIReference
url: https://support.nationbuilder.com/en/articles/10857983-interactive-api-documentation-endpoint-explorer
- type: GettingStarted
url: https://support.nationbuilder.com/en/articles/9869274-nationbuilder-api-quickstart-guide
- aid: nationbuilder:nationbuilder-signup-profiles-api
name: Nati
# --- truncated at 32 KB (45 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/nationbuilder/refs/heads/main/apis.yml