NAnationbuilder
Suggestion Boxes

List all suggestion boxes in a nation

Changed on

Returns a paginated list of all SuggestionBoxes across all sites.

get/api/v2/suggestion_boxes

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 suggestion boxes.

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": "suggestion_boxes",
      "attributes": {
        "allow_image": true,
        "auto_response_broadcaster": "1",
        "content": "Share your ideas for improving our community",
        "external_id": "ext-123",
        "headline": "Community Ideas",
        "name": "Community Ideas",
        "official_response_notification_broadcaster": "1",
        "point_person_id": "1",
        "response_notification_broadcaster": "1",
        "send_auto_responses": true,
        "send_official_response_notifications": true,
        "send_response_notifications": true,
        "site_id": "123",
        "slug": "my-page-slug",
        "status": "published",
        "tag_list": "Good, Bad, Important, Easy, Impractical",
        "title": "Community Ideas - My Site",
        "created_at": "2019-10-26T10:00:00-04:00",
        "page_id": "1",
        "updated_at": "2019-10-26T10:00:00-04:00"
      }
    }
  ],
  "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 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
    • info

      endpoint added