API Usage Patterns

Global URL Parameters

The following URL parameters are common to all authenticated API requests.

  • access_token

    • Can be the resulting token generated by an oauth request (see quickstart)
    • Can be a test-token generated by a nation's administrator (Settings->Developer->API Token)
    • Example: 
      GET https://foobar.nationbuilder.com/api/v1/people?access_token=MY_ACCESS_TOKEN
  • fire_webhooks

    • Defaults to "true" for all API requests
    • Setting to "false" will disable the firing of any webhooks that could result from that API request
    • Example: 
      POST https://foobar.nationbuilder.com/api/v1/people?access_token=MY_ACCESS_TOKEN&fire_webhooks=false

Be the first to comment

Wrap code snippets in <code></code> tags.
Please check your e-mail for a link to activate your account.