NAnationbuilder
Suggestion Boxes

Show SuggestionBox with provided ID

Changed on

Retrieves a specific SuggestionBox by its ID.

get/api/v2/suggestion_boxes/{id}

Request

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

Query parameters

includeSuggestionBoxSideloadValues[]

Comma-delimited list of sideloaded resources to include as part of the suggestion box response. See guidance here about sideloading large numbers of resources and pagination.

fields[suggestion_boxes]SuggestionBoxFieldValues[]

Comma-delimited list of suggestion box attributes to only return in the response

Response

The requested suggestion box.

metaobject

Non-standard information about the document. 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"
    }
  },
  "included": [
    {
      "id": "1"
    }
  ]
}

Changes

  • d5c88ca497acRevision changes
    • breaking

      for the query request parameter fields[suggestion_boxes], default value was added

    • breaking

      for the query request parameter include, default value was added

    • breaking

      for the query request parameter fields[suggestion_boxes], the type changed from string to array

    • breaking

      for the query request parameter include, the type changed from string to array

    • 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

    • 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

    • info

      added the non-success response with the status

  • 31995b0a1e61Revision changes
    • info

      endpoint added