Skip to content
SynupAPI
Get an API key
GETapi.synup.com/api/v4/reviewDetails

List Interactions by IDs

This API retrieves multiple interactions using their unique identifiers in a single request.

Behavior:

  • Supports batch retrieval for efficiency.
  • Ensures only valid interaction IDs return data.
  • Returns full interaction details, including content, platform, timestamp, and response status.
Requires an API key. Send it as Authorization: API <your-key> — see Getting started.

Parameters

Query

NameTypeRequiredDescription
interactionIdsarrayrequiredArray of interaction IDs to fetch.

Must be URL encoded array of quoted UUIDs in square brackets. Example: [%2258765b87-48b6-4bb5-88fa-62500842a383%22%2C%20%2280d22b99-3c57-4e50-90ca-6f38a7d43e50%22]

Request

Request
curl -X GET 'https://api.synup.com/api/v4/reviewDetails?interactionIds=' \
  -H 'Authorization: API YOUR_API_KEY' \
  -H 'Content-Type: application/json'

Responses

StatusDescription
200Successful response
Example response
{
  "data": {
    "interactionDetails": {
      "interactions": []
    }
  }
}

Response body

NameTypeRequiredDescription
dataobjectoptional
data.interactionDetailsobjectoptional
data.interactionDetails.interactionsarray of objectoptional
data.interactionDetails.interactions[].idstringoptionalUnique identifier
data.interactionDetails.interactions[].interactionIdstringoptionalAlternative interaction identifier
data.interactionDetails.interactions[].sourcestringoptionalSource platform (e.g., yelp.com)
data.interactionDetails.interactions[].titlestringoptionalInteraction title if available
data.interactionDetails.interactions[].contentstringoptionalInteraction content
data.interactionDetails.interactions[].locationDbIdstringoptionalDatabase ID of location
data.interactionDetails.interactions[].locationEncodedIdstringoptionalBase64 encoded location ID
data.interactionDetails.interactions[].authorNamestringoptionalName of author
data.interactionDetails.interactions[].authorAvatarstringoptionalURL to author's avatar
data.interactionDetails.interactions[].authorUrlstringoptionalURL to author's profile
data.interactionDetails.interactions[].authorInfostringoptionalAdditional author information
data.interactionDetails.interactions[].ratingintegeroptionalRating value (1-5)
data.interactionDetails.interactions[].datestringoptionalInteraction timestamp
data.interactionDetails.interactions[].permalinkstringoptionalURL to original interaction
data.interactionDetails.interactions[].categorystringoptionalInteraction category
ReviewSocial
data.interactionDetails.interactions[].typestringoptionalInteraction type
ReviewCommentPostPhotoResponse
data.interactionDetails.interactions[].photoUrlstringoptionalURL to interaction photo
data.interactionDetails.interactions[].photoThumbnailUrlstringoptionalURL to photo thumbnail
data.interactionDetails.interactions[].respondedbooleanoptionalWhether interaction has been responded to
data.interactionDetails.interactions[].notesstringoptionalAccount owner's notes
data.interactionDetails.interactions[].responsesarray of objectoptionalArray of responses
data.interactionDetails.interactions[].responses[].interactionIdstringoptionalResponse ID
data.interactionDetails.interactions[].responses[].sourcestringoptionalSource platform
data.interactionDetails.interactions[].responses[].titlestringoptionalResponse title
data.interactionDetails.interactions[].responses[].contentstringoptionalResponse content
data.interactionDetails.interactions[].responses[].locationDbIdstringoptionalLocation database ID
data.interactionDetails.interactions[].responses[].locationEncodedIdstringoptionalBase64 encoded location ID
data.interactionDetails.interactions[].responses[].authorNamestringoptionalResponder name
data.interactionDetails.interactions[].responses[].authorAvatarstringoptionalResponder avatar URL
data.interactionDetails.interactions[].responses[].authorUrlstringoptionalResponder profile URL
data.interactionDetails.interactions[].responses[].authorInfostringoptionalAdditional responder info
data.interactionDetails.interactions[].responses[].ratingintegeroptionalResponse rating if applicable
data.interactionDetails.interactions[].responses[].datestringoptionalResponse timestamp
data.interactionDetails.interactions[].responses[].permalinkstringoptionalURL to response
data.interactionDetails.interactions[].responses[].categorystringoptionalResponse category
data.interactionDetails.interactions[].responses[].typestringoptionalAlways "Response"
Response
data.interactionDetails.interactions[].responses[].photoUrlstringoptionalResponse photo URL
data.interactionDetails.interactions[].responses[].photoThumbnailUrlstringoptionalResponse photo thumbnail
data.interactionDetails.interactions[].responses[].respondedbooleanoptionalResponse status
data.interactionDetails.interactions[].responses[].notesstringoptionalNotes on response
data.interactionDetails.interactions[].responses[].responseCountintegeroptionalNumber of sub-responses
data.interactionDetails.interactions[].responses[].canRespondbooleanoptionalWhether sub-responses allowed
data.interactionDetails.interactions[].responses[].totalResponsesintegeroptionalTotal sub-responses
data.interactionDetails.interactions[].responses[].locationIdintegeroptionalLocation ID
data.interactionDetails.interactions[].responses[].respondedWithstringoptionalTemplate used
data.interactionDetails.interactions[].responses[].respondedByintegeroptionalUser ID who responded
data.interactionDetails.interactions[].responses[].interactionStatusstringoptionalStatus of the response
CREATEDCOMPLETEDCONFIRMEDFAILED
data.interactionDetails.interactions[].responseCountintegeroptionalNumber of responses
data.interactionDetails.interactions[].canRespondbooleanoptionalWhether responses are allowed
data.interactionDetails.interactions[].totalResponsesintegeroptionalTotal number of responses
data.interactionDetails.interactions[].locationIdintegeroptionalNumeric location ID
data.interactionDetails.interactions[].respondedWithstringoptionalResponse template used
data.interactionDetails.interactions[].respondedByintegeroptionalUser ID who responded