NationBuilder is hiring

We're looking for software developers who want to change the world. Click here to learn more and apply.

Loading

API and Webhooks Documentation

Our API gives your application access to NationBuilder's core features.

Getting Started

Resource link Description
Quickstart Guide Guide to get an application registered and authorized to use data
API Explorer A tool for exploring the different API endpoints on a live nation
Ruby Quickstart Quickstart guide with example code for the Ruby programming language
PHP Quickstart Quickstart guide with example code for the PHP programming language
Python Quickstart  Quickstart guide with example code for the Python programming language

Sample App

An example application made with Ruby on Rails
Rate Limit Policy Explanation of our rate limiting policy
Email list Sign up for periodic email updates about the API

Libraries 

Library name Description
nationbuilder-rb The official Ruby client for the NationBuilder API

Endpoints 

Objects Description
Basic Pages Interact with the basic pages on a nation's website 
Blog Posts Interface with the blog posts that make up a blog on a nation 
Blogs Interface with the blogs on a nation 
Calendars Get information about the calendars the nation manages 
Campaign Data Get the nation's metadata on campaign information
Contacts Register contacts made to people in your nation.
Donations Access the donations made to the nation 
Events Get information about the events the nation manages. Also see the event resource description.
Imports Create and run imports into your nation 
Lists Interface with lists of people in your nation
Memberships Grant and customize memberships
Page Attachments Attach and remove static files to a page 
People Interface with the people information stored in your nation 
People Tags List tags that a nation uses and people who have a certain tag
Political Capital Interface with the political capital associated with each person
Sites Get information about the sites the nation manages 
Surveys Manipulate NationBuilder surveys
Webhooks Interface to creating webhooks from the API

 Webhooks

Document Description
Overview General information about NationBuilder webhooks
People Payloads sent in response to changes to people
Donations Payloads sent in response to changes to donations

Note

We love to hear your feedback and hope you'll use our developer forum to contribute resources and ask questions that will help build up our knowledge base. Have suggestions for improvements to this documentation? We respond to pull requests.

If you think you've found a bug or have questions about an issue with your API implementation, we've put together a cheat sheet for bug reporting. Following these guidelines will get you the best response from our team. 

Our rate limit policy is described here. The REST API runs on the same infrastructure as the NationBuilder app, and you can view current and historical uptime reports at status.nationbuilder.com.

If you're looking for the NationBuilder Election Center API, documentation is here.

Please direct API-related questions to api@nationbuilder.com

Do you like this page?