Google Business · Google Business Reviews

Batch get reviews

Batches get reviews.

POSThttps://api.pozy.ai/v1/accounts/{accountId}/gmb-reviews/batch
batchGetGoogleBusinessReviews

Guide: Google reviews

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the engagement resource group disabled get 403 resource_group_disabled. Authentication

Path parameters

NameTypeNotes
accountIdrequiredstring

Request body

application/json, required

  • locationNamesarray of stringrequired

    At least 1 item. Up to 50 items. Each item: matches ^accounts/[^/]+/locations/[^/]+$.

  • pageSizeinteger

    Default 50. 1 to 50.

  • pageTokenstring
  • orderBystring

    One of updateTime desc, rating, rating desc. Default updateTime desc.

Example

curl -X POST "https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/gmb-reviews/batch" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "locationNames": [
    "Acme"
  ]
}'

Response

200 on success

  • successboolean
  • accountIdstring
  • locationReviewsarray of object
    • namestring
    • reviewobject
  • nextPageTokenstring
200 response
{
  "success": true,
  "accountId": "696e0b682d0a31188e7a2ba9",
  "locationReviews": [
    {
      "name": "Acme",
      "review": {}
    }
  ],
  "nextPageToken": "string"
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400invalid_request_errorA parameter or body field is missing or invalid. param names it.
401authentication_errorThe API key is missing, revoked or expired.
403permission_errorThe key is read-only, scoped to other profiles, or has this resource group disabled.
404not_foundNothing with that id exists in your workspace.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in Google Business Reviews