Questionnaires

Fetch suggestion list by ID

Returns a single suggestion list with every song on it in data, in the order the business arranged them. Use this to show a customer what a song or song_list question offers, or to check what an answer was picked from.

Each item in data carries id, name, artistName, albumName, songNotes, spotifyUrl, youtubeUrl, appleMusicUrl and soundCloudUrl. Anything the business left blank is null.

songNotes belongs to the list, not to the answer. It is the business's own note about the song — "requires the clean edit", "played at every reception" — and it is never stored as part of a questionnaire answer. A customer's note about their choice is selectionNotes in the questionnaire's values.

Recording an answer means writing the song's fields into values under the question's uuid, along with songSuggestionListId set to this list's id.

Required permission: planning_read.

get/api/v1/suggestion_lists/{id}

Request

  • Base URL: https://api.checkcherry.com
  • URL: https://api.checkcherry.com/api/v1/suggestion_lists/{id}
  • Auth: none declared. Required headers: Api-Key

Path parameters

idinteger required

The unique ID of the suggestion list

Headers

Api-Keystring required

Your Integration Key

Response

suggestion list found

Changes

No recorded changes to this operation across all 2 revisions of this API.