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
| Name | Type | Required | Description |
|---|---|---|---|
interactionIds | array | required | Array 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'const res = await fetch('https://api.synup.com/api/v4/reviewDetails?interactionIds=', {
method: 'GET',
headers: {
Authorization: 'API YOUR_API_KEY',
'Content-Type': 'application/json',
},
});
const data = await res.json();import requests
res = requests.get(
"https://api.synup.com/api/v4/reviewDetails?interactionIds=",
headers={
"Authorization": "API YOUR_API_KEY",
"Content-Type": "application/json",
},
)
data = res.json()req, _ := http.NewRequest("GET", "https://api.synup.com/api/v4/reviewDetails?interactionIds=", nil)
req.Header.Set("Authorization", "API YOUR_API_KEY")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)Responses
| Status | Description |
|---|---|
200 | Successful response |
Example response
{
"data": {
"interactionDetails": {
"interactions": []
}
}
}Response body
| Name | Type | Required | Description |
|---|---|---|---|
data | object | optional | |
data.interactionDetails | object | optional | |
data.interactionDetails.interactions | array of object | optional | |
data.interactionDetails.interactions[].id | string | optional | Unique identifier |
data.interactionDetails.interactions[].interactionId | string | optional | Alternative interaction identifier |
data.interactionDetails.interactions[].source | string | optional | Source platform (e.g., yelp.com) |
data.interactionDetails.interactions[].title | string | optional | Interaction title if available |
data.interactionDetails.interactions[].content | string | optional | Interaction content |
data.interactionDetails.interactions[].locationDbId | string | optional | Database ID of location |
data.interactionDetails.interactions[].locationEncodedId | string | optional | Base64 encoded location ID |
data.interactionDetails.interactions[].authorName | string | optional | Name of author |
data.interactionDetails.interactions[].authorAvatar | string | optional | URL to author's avatar |
data.interactionDetails.interactions[].authorUrl | string | optional | URL to author's profile |
data.interactionDetails.interactions[].authorInfo | string | optional | Additional author information |
data.interactionDetails.interactions[].rating | integer | optional | Rating value (1-5) |
data.interactionDetails.interactions[].date | string | optional | Interaction timestamp |
data.interactionDetails.interactions[].permalink | string | optional | URL to original interaction |
data.interactionDetails.interactions[].category | string | optional | Interaction categoryReviewSocial |
data.interactionDetails.interactions[].type | string | optional | Interaction typeReviewCommentPostPhotoResponse |
data.interactionDetails.interactions[].photoUrl | string | optional | URL to interaction photo |
data.interactionDetails.interactions[].photoThumbnailUrl | string | optional | URL to photo thumbnail |
data.interactionDetails.interactions[].responded | boolean | optional | Whether interaction has been responded to |
data.interactionDetails.interactions[].notes | string | optional | Account owner's notes |
data.interactionDetails.interactions[].responses | array of object | optional | Array of responses |
data.interactionDetails.interactions[].responses[].interactionId | string | optional | Response ID |
data.interactionDetails.interactions[].responses[].source | string | optional | Source platform |
data.interactionDetails.interactions[].responses[].title | string | optional | Response title |
data.interactionDetails.interactions[].responses[].content | string | optional | Response content |
data.interactionDetails.interactions[].responses[].locationDbId | string | optional | Location database ID |
data.interactionDetails.interactions[].responses[].locationEncodedId | string | optional | Base64 encoded location ID |
data.interactionDetails.interactions[].responses[].authorName | string | optional | Responder name |
data.interactionDetails.interactions[].responses[].authorAvatar | string | optional | Responder avatar URL |
data.interactionDetails.interactions[].responses[].authorUrl | string | optional | Responder profile URL |
data.interactionDetails.interactions[].responses[].authorInfo | string | optional | Additional responder info |
data.interactionDetails.interactions[].responses[].rating | integer | optional | Response rating if applicable |
data.interactionDetails.interactions[].responses[].date | string | optional | Response timestamp |
data.interactionDetails.interactions[].responses[].permalink | string | optional | URL to response |
data.interactionDetails.interactions[].responses[].category | string | optional | Response category |
data.interactionDetails.interactions[].responses[].type | string | optional | Always "Response"Response |
data.interactionDetails.interactions[].responses[].photoUrl | string | optional | Response photo URL |
data.interactionDetails.interactions[].responses[].photoThumbnailUrl | string | optional | Response photo thumbnail |
data.interactionDetails.interactions[].responses[].responded | boolean | optional | Response status |
data.interactionDetails.interactions[].responses[].notes | string | optional | Notes on response |
data.interactionDetails.interactions[].responses[].responseCount | integer | optional | Number of sub-responses |
data.interactionDetails.interactions[].responses[].canRespond | boolean | optional | Whether sub-responses allowed |
data.interactionDetails.interactions[].responses[].totalResponses | integer | optional | Total sub-responses |
data.interactionDetails.interactions[].responses[].locationId | integer | optional | Location ID |
data.interactionDetails.interactions[].responses[].respondedWith | string | optional | Template used |
data.interactionDetails.interactions[].responses[].respondedBy | integer | optional | User ID who responded |
data.interactionDetails.interactions[].responses[].interactionStatus | string | optional | Status of the responseCREATEDCOMPLETEDCONFIRMEDFAILED |
data.interactionDetails.interactions[].responseCount | integer | optional | Number of responses |
data.interactionDetails.interactions[].canRespond | boolean | optional | Whether responses are allowed |
data.interactionDetails.interactions[].totalResponses | integer | optional | Total number of responses |
data.interactionDetails.interactions[].locationId | integer | optional | Numeric location ID |
data.interactionDetails.interactions[].respondedWith | string | optional | Response template used |
data.interactionDetails.interactions[].respondedBy | integer | optional | User ID who responded |