Listings API

Name	Type	Required	Description	Default
interactionIds	string	required	JSON-encoded array of interaction IDs to fetch, e.g. `["b2fa765e-c62b-4e0b-b1d6-1c67c855f5e0"]`. Passed as a URL-encoded JSON string.	—

Name

Type

Required

Description

Default

interactionIds

string

required

JSON-encoded array of interaction IDs to fetch, e.g. `["b2fa765e-c62b-4e0b-b1d6-1c67c855f5e0"]`. Passed as a URL-encoded JSON string.

—

Responses

200Interaction details for the requested IDs. `data.interactionDetails.interactions` holds the array.

{
  "data": {
    "interactionDetails": {
      "interactions": [
        {
          "id": "b2fa765e-c62b-4e0b-b1d6-1c67c855f5e0",
          "source": "maps.google.com",
          "content": "Great place for dessert!",
          "authorName": "Jordan M.",
          "category": "Review",
          "type": "Review",
          "rating": 5,
          "date": "2026-05-12T09:22:41+00:00",
          "responded": true,
          "responseCount": 1,
          "canRespond": true,
          "responses": [
            {
              "id": "2090753a-ece6-4837-8336-8494ad308523",
              "content": "Thank you so much for the kind words!",
              "authorName": "Jenny Home",
              "date": "2026-05-13T14:02:00+00:00",
              "interactionStatus": "CONFIRMED",
              "editedResponse": false
            }
          ]
        }
      ]
    }
  }
}

401Unauthenticated — missing or invalid API key.

Fetches full interaction details for one or more specific interaction IDs. Useful when you have stored interaction IDs and need fresh data for them without paginating through the full interactions list. The response body is data.interactionDetails.interactions, an array of interaction objects (see the interaction attributes reference).

Pass interactionIds as a URL-encoded JSON array. When an ID does not belong to your account, the endpoint returns 200 with data.interactionDetails set to null and an errors array (e.g. SY90001: Not Authorized to access this resource); omitting the parameter entirely returns SY90006.

Use case: hydrating a stored watchlist

If you build a notification system that stores interaction IDs (for example, reviews a user starred), call this endpoint periodically to re-hydrate them and detect newly posted owner responses or a changed responded flag — no need to re-scan the whole reviews list. The responses[].id returned here is the responseId you pass to Edit a response or Archive a response.

Get interactions by IDs

Parameters

Query

Responses

Use case: hydrating a stored watchlist