Skip to content
SynupAPI
Get an API key

Interaction__v4

Fields

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