Listings APIListings API
Get API keySign in

Interaction attributes reference

Field reference for the interaction and response objects returned by the interactions endpoints.

Interaction objects are returned by List interactions for a location, Get rollup interactions, and Get interactions by IDs. The paginated endpoints wrap them in a Relay-style connection, the response body is data.interactions (per location), data.rollupInteractions (account rollup), or data.interactionDetails (by IDs), each containing edges[].node, pageInfo, and (for connections) totalCount.

Interaction fields

FieldTypeDescription
idStringGlobally unique interaction ID (used as interactionId when responding)
interactionIdStringRaw interaction identifier
sourceStringHostname of the review/social site (e.g. maps.google.com, yelp.com)
titleStringInteraction title, when the source provides one
contentStringReview or post body text
authorNameStringDisplay name of the author
ratingIntegerStar rating, 1–5 (reviews only)
dateStringISO 8601 timestamp of the interaction
permalinkStringDirect link to the interaction on the source site
categoryStringHigh-level bucket, e.g. Review or Social
typeStringSpecific interaction type, Review, Question, Comment, Recommendation, Post, Photo, Message, Response
respondedBooleanWhether an owner response exists
notesStringAccount owner's private notes
responsesArrayOwner responses attached to this interaction (see below)
responseCountIntegerNumber of responses attached
canRespondBooleanWhether a response can be posted from Listings API for this source
locationIdIntegerNumeric database ID of the owning location
flaggedReasonStringReason 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):

FieldTypeDescription
idStringUnique response ID (pass as responseId when editing or archiving)
interactionIdStringID of the interaction this response belongs to
contentStringText of the response
authorNameStringName shown as the responder
dateStringTimestamp the response was created
respondedWithStringResponse template ID used, if any
respondedByIntegerListings API user ID that submitted the response
interactionStatusStringLifecycle state, CREATED, FAILED, COMPLETED, or CONFIRMED
editedResponseBooleanWhether this response has been edited since first posted
remarksStringSystem 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)