Skip to main content
POST
local.review.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
reviewId
string
required

From local.reviews.list or local.reviews.batch.list.

Required string length: 1 - 256
accountId
string

The connected business account, from local.locations.list. Optional when only one is connected.

Required string length: 1 - 256
locationId
string

A location id from local.locations.list. Omit to use the selected location.

Required string length: 1 - 256

Response

The result

id
string
required

Pass to local.review.reply.

rating
number

1 to 5 stars.

text
string

Review text.

reviewer
string

The reviewer's public display name.

publishedAt
string

Publish time, ISO 8601.

updatedAt
string

Last edit time, ISO 8601.

reply
object

Your current reply, if any.

photoCount
number

Number of photos on the review.