NAnationbuilder
Events

List all events in a nation

Changed on

Lists all events within a nation.

get/api/v2/events

Request

  • Base URL
    https://yournation.nationbuilder.com
  • Auth
    HTTP bearer

Query parameters

page[number]string

Page number to list (starting at 1)

page[size]string

Number of results to display per page (default: 20, max: 100, min: 1)

Response

A page of matching events.

metaobject

Non-standard information about the document, such as requested statistics. Empty unless the endpoint has metadata to convey.

Example response

{
  "data": [
    {
      "id": "1",
      "type": "events",
      "attributes": {
        "additional_rsvps_count": 20,
        "attending_count": 100,
        "auto_response_broadcaster_id": "1",
        "auto_response_content": "Content of autoresponse",
        "auto_response_subject": "Subject of autoresponse",
        "capacity_count": 200,
        "contact_email": "jdoe@work.com",
        "contact_name": "John Doe",
        "contact_phone_number": "5555555555",
        "content": "Event description",
        "donation_tracking_code_id": "1",
        "duration": 3600,
        "event_form_address": "required",
        "event_form_phone": "required",
        "point_person_id": "1",
        "start_at": "2019-10-26T10:00:00-04:00",
        "time_zone": "Eastern Time (US & Canada)",
        "user_ticket_currency": "USD",
        "user_ticket_price_in_cents": 400,
        "user_ticket_purchase_url": "https://www.example.com",
        "venue_name": "Event Center",
        "page_id": "1"
      }
    }
  ],
  "links": {
    "self": "/articles?page[number]=2",
    "first": "/articles?page[number]=1",
    "last": "/articles?page[number]=5",
    "prev": "/articles?page[number]=1",
    "next": "/articles?page[number]=3"
  },
  "included": [
    {
      "id": "1"
    }
  ]
}

Changes

  • d5c88ca497acRevision changes
    • breaking

      for the query request parameter page[number], default value 1 was added

    • breaking

      for the query request parameter page[size], default value 20 was added

    • breaking

      the response's body type changed from object to no type for status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional query request parameter extra_fields[events] to all path's operations

    • info

      added subschema #2 to the response body allOf list for the response status

    • info

      media type application/json was changed to a more specific media type application/vnd.api+json for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 31995b0a1e61Revision changes
    • warning

      added the new America/Adak enum value to the /////// response property for the response status

    • warning

      added the new Antarctica/Troll enum value to the /////// response property for the response status

    • warning

      added the new Australia/Eucla enum value to the /////// response property for the response status

    • warning

      added the new Australia/Lord_Howe enum value to the /////// response property for the response status

    • warning

      added the new Canada/Yukon enum value to the /////// response property for the response status

    • warning

      added the new Pacific/Gambier enum value to the /////// response property for the response status

    • warning

      added the new Pacific/Kiritimati enum value to the /////// response property for the response status

    • warning

      added the new Pacific/Marquesas enum value to the /////// response property for the response status

    • warning

      added the new Pacific/Pitcairn enum value to the /////// response property for the response status