Hi! I'm trying to call the people/search endpoint, searching on a custom field. As per the documentation it seems the url below would work for searching for us_citizen=true, but it returns a 500. Suggestions on what I'm doing wrong? Thanks! https://mynation.nationbuilder.com/api/v1/people/search?custom_values=custom_values%5Bus_citizen%5D%3Dtrue&limit=100&access_token=XXX Heather

Hi, It is possible to get the primary address, but I can not find a way to get the registered address. What can I do? Thanks

Hi, We would like to make NationBuilder more central in our infrastructure. We would like to build on top of it. Is there a way to authenticate users in our Mobile App with NationBuilder. And I am not talking about authenticating the Admins. This is what OAuth2 is for. I would like to authenticate the users in our nation that are thousands. We would like to keep certain information in our NationBuilder. Information about the user membership. A custom field that says if this use has access to our venue or no. That's it. We would like to give our users (not the nation builder admins) but the nation itself a Mobile App. A mobile app that will read this custom field and say to the users (not the admins, but the users in the nation) if they have access to our venue. The issue is that if a user has a Mobile app on their phone there is no way for them to authenticate with nation builder. NationBuilder is not an SSO Provider and there is no API endpoint for an App to check the username and password of a user using the Mobile App. So we can build web/modile apps for the nation builder admins, but we can not build web/mobile apps for the nation builder users, those that are part of our nation. What am I missing? Help me understand how could we build web/mobile apps that allow us to authenticate the users in our nation (not the admins of the nationbuilder.com installation) with NationBuilder. Thanks.

Which is the Top Mobile App Development Company in India?

I am facing issues with http and https to https//www. is not redirect. http is redirecting https//www. but https is not redirect. Can anyone suggest me how we resolve it

I can't find any api documentation of type Swagger or OpenApi specification. Is there a hidden one ? If not, could you add one ? Thank you

Hello, Looking at the Authentication process, could you implement the client_credentials grant type ? It would help authenticating from machine to machine without having to rely on a user account. It would allow those who don't like long lived tokens for their security risks to have an alternative. Many thanks

I'm trying to figure out the most efficient way to pull a list of people in my organization who are recurring donors. This seems to be relatively straightforward from the people admin page through the web portal, but it does not look like I can set a query parameter for this through the People API. It looks like the only way to do this is to go through the Donation API, but there it looks like I will have to make a very large number of API calls as there isn't an easy way to filter on this either. Is there an alternate solution? Thanks.

Is there anywhere we can find the url of page attachments in the snapshot?

I am having an issue with a simple app script to create a person record in NationBuilder. I've checked my JSON data and verified it with REQBIN and it works in the API explorer. The error is "I can only talk JSON. Please set 'Accept' and 'Content-Type' to 'application/json'" I have both of the attributes in the options model. I've even tried every possible capitalization combination.??? If anyone has some google app script that is known to work, I would really appreciate it. Everything I have found so far isn't working. TIA.

How can I prove the identity of a logged-in user in a Nationbuilder theme to a 3rd party API that I control? As officially answered in https://nationbuilder.com/xdjc/making_nationbuilder_api_requests_inside_of_a_nationbuilder_theme, there's no way to get an API token or other token from Nationbuilder inside of javascript that can prove the identity of the logged in user to third party APIs. However, that answer also says the correct way to make Nationbuilder API calls from a theme is to set up a 3rd party API and call it from the template. So, how can I prove to the API that the request coming in is in fact coming from a logged-in user in nationbuilder and isn't being faked? And how can it verify the user ID is in fact who the user request says it is? Another way would be to use a HMAC with a secret key inside of liquid, but as officially answered in https://nationbuilder.com/xdjc/when_will_nationbuilder_liquid_support_the_hmac_sha256_filter, there are no hmac filters in nationbuilder either. So what's the recommended solution? Or do I just need to not have any authentication on the API, and just pray that the requests are really coming from a logged-in user on Nationbuilder and not a malicious actor?

Currently the only way I can find to have a nationbuilder theme make a secure API call is to hash some auth info about the current user in the template with a secret key. Shopify Liquid and most liquid variants support the hmac_sha256 filter (https://shopify.dev/docs/themes/liquid/reference/filters/string-filters#hmac_sha256) for this purpose, and have for several years. However, sadly this is not available in nationbuilder yet. The only hashing function available in nationbuilder liquid is md5, which is much less secure and isn't a hmac. When will nationbuilder liquid support his important hmac_sha256 filter? I think given how much nationbuilder's users are targets for hackers, it's absolutely essential for nationbuilder to support the hmac_sha256 liquid filter.

I need to be able to make calls to the nationbuilder API inside of a nationbuilder theme on behalf of the current user. Is there a way to get an API token for the user inside of a template? I see there's _nbuild_token and _nbuild_session cookies, but those don't work as API access tokens. I don't see any liquid template variables that look like they would be useful in getting an access token for the current user. Alternatively, I can set up a REST server that can make calls to the nationbuilder API, and make requests to that from my template. However, I need some way to verify who the user is that's making that call. If I send the _nbuild_token and/or _nbuild_session from the cookies along with the REST request, is there some way to verify which user_id that token belongs to on the backend? I just need some way to validate that the user making the request is a logged-in user on my nationbuilder site so I know what they should or shouldn't have access to.

How to cancel a recurring donation? By looking at API documentation I've noticed that each donation has two fields: recurring_donation_id (which is not writable) and canceled_at.

I have searched through the API docs and developer forum and do not see an endpoint for fetching a list of the keys in a nation. I would like to bring back all of the standard fields as well as the keys of any custom fields in the nation. The only route I see is to fetch a person and pull the keys from the response. I'm concerned this may not return all of the keys present in the nation if this one person has null values for some keys.

Sorry for the question, i'll receive a lot of equal webhook callback, Is there a way to prevent this ? i don't know, for example reply with an empy body with status code 200? thanks for help

Is it possible to update multiple people in a single query? The only option I see is the /people/push endpoint, which accepts a single person.

I am fetching a batch of people from the /people endpoint. I want the contacts' home_address and work_address values. My understanding is the /people endpoint is only capable of returning the primary_address and if I want to get the home_address, work_address, or other specific address, I would need to query the /people/:id endpoint. I'd rather query the /people endpoint just once rather than the /people/:id endpoint once for each and every contact. Is it in fact possible to fetch specific addresses with the /people endpoint?

How can I get person specific transaction history? Complete records a person has in Nationbuilder with timestamp?

I would like to design my nation in Webflow because that's what I already know how to use. Im not a developer; Im a marketer. How could I import this design into NationBuilder? Looking into the documentation a bit, I think i'll have to export the Webflow theme in Bootstrap format if possible? Then go and manually import each of the bootstrap files into the right places in the NationBuilder DropBox Bootstrap layout? Would anyone want to do this for me for a fee?

I'm attempting to check the tags that will be added to users when they RSVP, but that attribute does not appear to be returned by the events API. We get the page tags, but not the RSVP tags. Seems like those are saved here — [signup_action_callbacks_attributes][0][tag_list] When setting up any number of events, it's very easy to miss a setting, and this is a major point of pain for my nation — if an event goes by and the RSVP tags are missing, we've got a whole set of people mis-tagged. I'm just trying to build a tool that would flag those events so we can fix them — so I'd only need read access to this attribute. Wondering if there's any way I can get access to this attribute on events?

Using the API, how can I update which address is currently used as the primary address? e.g. mailing, home, billing, ... It would also make sense if the person object included which address is currently set as the primary address. This is helpful to know which address to update.

When adding a tag to someone in your database, the 'person changed' webhook will not fire until you save that profile or a different profile in the database. This makes syncing tags with an external database a challenge.

Is there a way to validate authorization token? For example, Google has such an endpoint https://www.googleapis.com/oauth2/v3/tokeninfo?id_token=MYTOKEN which returns token info if it is a valid one. It is doable with Facebook as well. graph.facebook.com/debug_token?input_token={token-to-inspect}&access_token={app-token-or-admin-token} Does Nation Builder provide similar endpoint? Thanks

When importing people using the import call from the API, although the Errors CSV file is available in the people import report, and that the correct number of failure is reported in the response, the field failure_csv is returned empty (null). Here's an example of responses: {"result":{"rows_updated":0,"rows_succeeded":0,"rows_failed":9,"failure_csv":null}} {"result":{"rows_updated":2360,"rows_succeeded":2612,"rows_failed":24,"failure_csv":null}} The response match exactly the report on the control panel, except for the file which is only available on from the control panel. The following params are used for the import call: 'type' => 'people', 'file' => [base 64 encoded csv file], 'is_overwritable' => 'true' Thanks for your help.

How can I add user to the nation builder after his registration on wordpress site

I’m working with my nation’s donation data, and I’d like to be able to search by more than just succeeded since, created since, failed since, and donor id. 

Is there any reason why I can’t pass tracking_code_id as a search parameter, or any of the other fields? Right now, my flow looks like this: 

Pull the entire list of donations that might match (say, by succeeded since date, or just pull them all)
Parse through and check the value/run my own search algorithm on the entire results I just pulled 
Do my processing 

Since I’m sometimes interested in searching all of our donations, that means each time I do this, I’m pulling down almost all of our donations, even if only 5-10 of them will match a criteria, like a tracking_code_id – it’s much slower than it needs to be, I think. 

Have I missed something? Is there a better way to use the search endpoint? What’s in the way of giving us access to this?

I suspect this is custom validation used across many API endpoints, but I specifically refer to the People Memberships endpoint (i.e. PUT to /people/:person_id/memberships) The validator rejects null values for expires_on, and will only accept strings. If we want to set expires_on to null, we must send it a non-date string. The API will reject "expires_on": null with an error, but will return "expires_on": null if the attribute sent is "expires_on": "". Further, the validator does not catch non-date strings. Sending "expires_on": "donuts" also results in the response "expires_on": null. Really, the output should match the input, and the date validator should check to see whether the attribute sent matches a valid value (i.e. ISO8601 date or null). Instead, the validator only rejects null values and the API translates any non-ISO8601 string to null.

The documentation, and API spec both list address3 as a field, however it doesn't seem to display on the front-end. I suspect the field was deprecated on the front-end but maintained in the external API for posterity. Also, the People documentation lists primary address as an attached resource, however it's not recorded as a read-only resource. I haven't had a deep look into the People API yet, but I'm fairly certain there will be other similar resources and attributes attached.

Is it possible to get a list of blog posts created by a specific author via the API? If so, can you link me to the page with the info for this because I cannot seem to locate anything about it. Thanks, Wil

Hello, I found a small mistake in the API documentation. On https://nationbuilder.com/people_api under the Push Endpoint, it says " If a match is not found, a new person is created and a 201 status code is returned", which is correct: https://cl.ly/rUFV But further down the page under "Creation example" it says "A new record will be created with the provided attributes and you will receive a response of status 200" (note the 200 instead of 201): https://cl.ly/rV8G Minor issue, but wanted to let you know! Thanks!

Our organization is using Nation Builder for their website and we would like to start developing a tool to manage our Blog, which will need to hook into the Blog API. I can easily code this, but need to get access to the API. What steps do I need to perform in order to gain access to the API? Thanks, Wil

I'm looking at a record in my nation that contains a phone number but when I use people/show endpoint the 'phone' resource is null. 'phone_normalized' does contain the number, however.

The /donations/index endpoint has a maximum limit of 1000, not 100. https://nationbuilder.com/donations_api#index_endpoint

The /person endpoint is generally quite strict on push, and it rejects invalid attributes on the object passed to it. For instance, fields which do not exist on the object or under custom fields will return a 400 with the error code "invalid_custom_field". However, the pseudo-attribute primary_address is accepted but no action is taken if it is passed. This should either be handled (i.e. a new address is created and assigned to the person), or the request should be rejected as invalid.

The Address resource documentation under the People API describes the country_code attribute as "country code". However, it appears the standard being used is ISO-3166-1 alpha-2 with upper-case characters. This is a requirement, entering a code which doesn't comply with this causes problems with NationBuilder's front-end. However, these requirements are not documented nor are they verified when an address resource is submitted.

I am building an app integration. I've implemented the OAuth flow described at https://nationbuilder.com/api_quickstart. Suppose that two nations, N1 and N2, both install my app. As a result of following the OAuth flow, my app has now obtained API tokens for both nations, so it can make API requests on behalf of either one. I want to limit who can prompt my app to act on behalf of a given nation. For example only someone affiliated with N1should be able to prompt my app to access N1's data via the NB API. Conversely someone affiliated with N1 should not be able to prompt my app to access N2's data. In order to limit access appropriately, my app needs a way to know which nation is asking it to do something. How can nations identify themselves to my app in a secure way?

As per my previous two posts concerning these matters, the people and search endpoints return a 400 when provided with unexpected URL parameters. The API Explorer provides them with one of these, __proto__. This should be removed so that the API Explorer actually works on these endpoints. https://nationbuilder.com/jeremyunite/bad_request_on_people_search_endpoint https://nationbuilder.com/jeremyunite/bad_request_on_donations_search_endpoint

People -> Donations is a one-to-many relationship, but there doesn't appear to be a way to get donations in this method. I haven't been able to find a Donations attribute on a Person (either full or restricted), there doesn't appear to be a Donations resource endpoint which allows searching by Donor ID, and the Donations search endpoint also doesn't allow Donor ID. Is there a way to get Donations from a single Person without getting all the Donations from the API, then filtering them after-the-fact?

Similar to my previous post, this endpoint is also needlessly strict. The API Explorer is also broken on this as a result. These endpoints need, at the very least, documentation explaining the inconsistent strictness, and the __proto__ URL parameter needs to be removed from the API Explorer. Moreover, this requirement to not include any unexpected URL parameters should be removed from the endpoints.

http://nationbuilder.com/donations_api The Donations API description of the is_private field reads "false if the donation should not be posted publicly on the site". Is this correct? If is_private == false, then the donation is private; and if is_private == true, then the donation isn't private?

If any unexpected parameters are sent to the /people/search endpoint, it fails with a 400 Bad Request, and doesn't explain further in the body text. This is a problem, especially considering the API Explorer adds an empty __proto__ URL param, which is rejected by the API with the message above. Really, the API should ignore any irrelevant URL parameters, rather than just mysteriously dying. If there's a technical limitation around these for some reason, the response text should at least be more verbose.

Currently, custom fields return a name and value. In the case of the Checkbox field type, there is no way to tell this apart from a Text field type. Where the custom fields for each nation is unknown, it is impossible to tell them apart and you end up with a situation where checkbox custom fields have to display a value of 1 or 0.

I just generated my first test token and have submitted it on the API Explorer along with my nation's slug. However none of the endpoints are generating any JSON feedback. In my browser Explorer, I see the following error in my console: SyntaxError: JSON.parse: unexpected character at line 1 column 1 of the JSON data. Can anyone help? Do I need to follow any additional steps to get the API Explorer working? I just want to set up a simple AJAX call within my nation's page template. This is my first time using the API. Any help is really appreciated! Thank you.

I'm trying to use the GET /tags/:tag/people endpoint, searching for a tag such as "Ajax/Bowmanville" and getting a 404 response. It works fine with a tag like "Ajax-Pickering" which doesn't have the front slash. I've tried replacing the front slashes with %2F, as suggested here http://nationbuilder.com/mdunbar50/issue_with_space_and_in_people_tags_search but it doesn't help. Any advice would help! Thanks

Hi I'm working on moving a Nationbuilder site over to Wordpress for the CMS. There is a request to keep the donation form the same, but it looks to me like this is not possible. I think I can use a Wordpress donations integration/plugin and after a donation is taken, send the information to the Nationbuilder API. Is it possible to use the nationbuilder donations for with Wordpress? Or is that a no go?

The People API seems to return a blank result for precinct_name for a person when the precinct is assigned via the NationBuilder Election Centre. Is this a bug or by design? If by design, how do we manage this?

Hello! Is there a mechanism for retrieving information about the current user in order to customize the experience for members who are interacting with external sites? With other CRMs we're able to identify the current user either through a cookie that is set via tracking redirect when members click links in emails sent by the CRM, or via a token included as a URL parameter appended to links in emails that are sent via the CRM. We use those tokens to retrieve information about the member when they reach our platform. It allows us to skip form completion steps by simply reusing the biographical information already stored in the CRM for that session. I think we asked NationBuilder about this feature years ago, but bumping it up in case something has been added to support this feature in the mean time. We just had another customer ask us for this in order to support one-click signing of petitions without requiring the user to provide email & name each time.

How can I delete an address through the API? I have tried using the people/:id endpoint but if I pass an object with something like "home_address": null it doesn't do anything. If I pass an address object with all the components set to null (ie { "address1": null, "address2":null, etc. }) I can see from the main GUI that the components have indeed been blanked but there is still a "delete address" button, which suggests that the address still exists on the system albeit with blank components.

The export csv contains address fields such as “primary_country” and “registered_country”, which contains the name of the country. The API People-endpoint does not contain those fields. The API does contain the “country_code” key. Is there another endpoint that allows me to read/write to the country name fields e.g. “primary_country” and “registered_country”?