Interaction attributes reference — Listings API

Interaction objects are returned by List interactions for a location, Get rollup interactions, and Get interactions by IDs. The two paginated endpoints wrap them in a Relay-style connection: data.interactions (per location) and data.rollupInteractions (account rollup) each carry edges[].node, pageInfo, and totalCount. Fetching by IDs does not paginate, data.interactionDetails is a plain { "interactions": [ ... ] } object with no edges, pageInfo, or totalCount.

Interaction fields

Field	Type	Description
id	String	The interaction's UUID. Pass it as `interactionId` when responding
interactionId	String	The same UUID as `id`; the service resolves both from one column
source	String	Hostname of the review/social site (e.g. `maps.google.com`, `yelp.com`)
title	String	Interaction title, when the source provides one
content	String	Review or post body text
authorName	String	Display name of the author
rating	Integer	Star rating, 1–5 (reviews only)
date	String	ISO 8601 timestamp of the interaction
permalink	String	Direct link to the interaction on the source site
category	String	High-level bucket, e.g. `Review` or `Social`
type	String	Specific interaction type, `Review`, `Question`, `Comment`, `Recommendation`, `Post`, `Photo`, `Message`, `Response`
responded	Boolean	Whether an owner response exists
notes	String	Account owner's private notes
responses	Array	Owner responses attached to this interaction (see below)
responseCount	Integer	Number of responses attached
canRespond	Boolean	Whether a response can be posted from Listings API for this source
locationId	Integer	Numeric database ID of the owning location
flaggedReason	String	Reason the interaction was flagged, if any

Response object fields

Each item in an interaction's responses array (and the object returned by Respond to an interaction):

Field	Type	Description
id	String	Unique response ID (pass as `responseId` when editing or archiving)
interactionId	String	ID of the interaction this response belongs to
content	String	Text of the response
authorName	String	Name shown as the responder
date	String	Timestamp the response was created
respondedWith	String	Response template ID used, if any
respondedBy	Integer	Listings API user ID that submitted the response
interactionStatus	String	Lifecycle state, `CREATED`, `FAILED`, `COMPLETED`, or `CONFIRMED`
editedResponse	Boolean	Whether this response has been edited since first posted
remarks	String	System remarks (e.g. failure detail)

Response status flow

The interactionStatus field tracks a response as it is posted out to the source site:

CREATED → COMPLETED: posted to the publisher; no double-confirmation available on that platform
CREATED → COMPLETED → CONFIRMED: posted and then confirmed by the publisher
CREATED → FAILED: submission to the publisher did not succeed; see remarks

Filter enums

The paginated endpoints accept these enum values as filters:

responseStatus: RESPONDED, PENDING
sortOrder: NEWEST_FIRST, OLDEST_FIRST, LAST_RESPONDED
category: REVIEW (and other high-level buckets exposed per account)