NAnationbuilder
Suggestions

Show suggestion with provided ID

Changed on

Retrieves a specific Suggestion by its ID.

get/api/v2/suggestions/{id}

Request

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

Query parameters

includeSuggestionSideloadValues[]

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

fields[suggestions]SuggestionFieldValues[]

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

Response

The requested suggestion.

metaobject

Non-standard information about the document. Empty unless the endpoint has metadata to convey.

Example response

{
  "data": {
    "id": "1",
    "type": "suggestions",
    "attributes": {
      "content": "We should add more parking spaces downtown",
      "external_id": "ext-123",
      "headline": "Downtown Parking Improvement",
      "official_response": "Thank you for this suggestion. We will consider it in our next planning session.",
      "recruiter_id": "1",
      "responded_at": "2019-10-26T10:00:00-04:00",
      "response_author_id": "1",
      "response_type_id": 2,
      "slug": "my-page-slug",
      "status": "published",
      "suggestion_box_id": "123",
      "created_at": "2019-10-26T10:00:00-04:00",
      "page_id": "1",
      "site_id": "123",
      "updated_at": "2019-10-26T10:00:00-04:00"
    }
  },
  "included": [
    {
      "id": "1"
    }
  ]
}

Changes

  • d5c88ca497acRevision changes
    • breaking

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

    • breaking

      for the query request parameter include, default value was added

    • breaking

      for the query request parameter fields[suggestions], 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