> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fetchski-attract.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Google reviews

> Retrieve a paginated list of Google reviews.

```ts AdonisJS wrap theme={"dark"}
import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
const googleReviewList = await site.googleReviews().listGoogleReviews()
```

```json 200 wrap theme={"dark"}
{
  "results": [
    {
      "title": "Example title",
      "reviewerName": "Example reviewer name",
      "isAnonymous": false,
      "rating": 5,
      "reviewText": "Example review text",
      "reviewedAt": "2026-10-24",
      "featured": false,
      "slug": "example-slug",
      "visibility": "public",
      "scheduledPublish": "Example scheduled publish",
      "scheduledUnpublish": "Example scheduled unpublish",
      "reviewerPhotoUrl": "https://acme.example/example",
      "ownerReply": "Example owner reply",
      "replyState": "Example reply state",
      "replyPolicyViolation": "Example reply policy violation",
      "stagedReply": "Example staged reply",
      "stagedReplyAction": "Example staged reply action",
      "reviewUrl": "https://acme.example/example",
      "source": "manual",
      "sourceId": "clx8m2k4p0000a1b2c3d4e5f6",
      "gbpLocationId": "clx8m2k4p0000a1b2c3d4e5f6",
      "archived": false,
      "_id": "clx8m2k4p0000a1b2c3d4e5f6",
      "type": "Example type",
      "createdAt": "2026-10-24T09:30:00.000Z",
      "updatedAt": "2026-10-24T09:30:00.000Z",
      "aposShareKey": "k3v9x2m7q1z8w4p6"
    }
  ],
  "pages": 1,
  "currentPage": 1
}
```

## In your app

A controller answers a route on your app: it calls `listGoogleReviews()` and returns the answer.

**1. Add the controller**

```ts app/controllers/list_google_reviews_controller.ts theme={"dark"}
import { inject } from '@adonisjs/core'
import { SiteClient } from '@fetchski/attract-cms-sdk'

@inject()
export default class ListGoogleReviewsController {
  constructor(protected site: SiteClient) {}

  async handle() {
    return this.site.googleReviews().listGoogleReviews()
  }
}
```

**2. Add the route**

```ts start/routes.ts theme={"dark"}
import router from '@adonisjs/core/services/router'

const ListGoogleReviewsController = () => import('#controllers/list_google_reviews_controller')

router.get('/google-review', [ListGoogleReviewsController])
```

**3. Call it**

```bash Terminal theme={"dark"}
curl http://localhost:3333/google-review
```

With `node ace serve` running, it prints its answer as JSON.

> [accordion] Optional parameters
>
> One object, e.g. `listGoogleReviews({ page })`; leave out the optional fields.
>
> **page** `number | null | undefined`
>
> **Optional.** Leave it out and the site uses `1`. Page number for pagination (1-based)
>
> **perPage** `number | null | undefined`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. Documents per page. Each content type has its own default (core’s is 50; a type may set another). There is no upper limit: a large value answers the whole list at once, which is slow on a big one. At least 1.
>
> **search** `string | null | undefined`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. Matches documents by their text. Ignored for the public and API keys on a type whose public fields leave some out (a search would match the hidden ones).
>
> **aposMode** `AposMode | null | undefined`
>
> **Optional.** Leave it out and the site uses `"published"`. `published` (the default) or `draft`. Drafts need a credential that may see them: an API key with the type’s write scope (`content:<type>:write`), or a signed-in editor. The public and a key with only the read scope get 403. One of `draft`, `published`.
>
> **aposLocale** `string | null | undefined`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. The locale to read or write, e.g. `en` (default: the site’s default locale).
>
> **renderAreas** `boolean | null | undefined`
>
> **Optional.** Leave it out and the site uses `false`. true: each area’s widgets come back rendered as HTML (`_rendered`), beside their data.
>
> **slug** `string | null | undefined`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. Only the document with exactly this slug: a list of one, or an empty list when none has it. Use it to find a document by the name in its URL.

> [accordion] Returns
>
> A `GoogleReviewList`. A page of GoogleReview documents. Read its properties (`googleReviewList.results`): each says whether the site always sends it. The example answer is the site’s wire JSON: one key differs from the property names (`_id` → `id`).
>
> **results** `readonly GoogleReview[]`
>
> **Always sent.** A list of `GoogleReview`. This page’s documents; empty past the last page.
>
> **GoogleReview**
>
> GoogleReview content type
>
> **title** `string`
>
> **Always sent.** Its title: the name it goes by in every list, and the heading of its page where it has one.
>
> **reviewerName** `string`
>
> **Always sent.** Reviewer name.
>
> **slug** `string`
>
> **Always sent.** The URL name: lowercase words joined by hyphens (letters outside a–z, even emoji, are kept).
>
> **id** `string`
>
> **Always sent.** The document’s id. On a type with drafts it ends in its locale and mode (`…:en:published`, `…:en:draft`): the part before the first colon is its `aposDocId`, shared by both copies. The `{_id}` the type’s routes take.
>
> **type** `string`
>
> **Always sent.** The document type’s name: always this type’s.
>
> **isAnonymous** `boolean | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Set when Google returned no reviewer name. The frontend shows a generic label + initial avatar.
>
> **rating** `number | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Rating (1–5).
>
> **reviewText** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Review text.
>
> **reviewedAt** `Date | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Review date. Format: an ISO 8601 date (`YYYY-MM-DD`).
>
> **featured** `boolean | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Hand-curation flag. The widget can be set to show only featured reviews.
>
> **visibility** `Visibility | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Select whether this content is public or private. One of `public`, `loginRequired`; a newer site may send others, so keep a fallback.
>
> **scheduledPublish** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. An ISO 8601 date and time, e.g. `2026-10-21T14:30:00.000Z`.
>
> **scheduledUnpublish** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. An ISO 8601 date and time, e.g. `2026-10-21T14:30:00.000Z`.
>
> **reviewerPhotoUrl** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The reviewer’s Google avatar URL, stored as-is (not downloaded). The frontend renders it directly and falls back to a lettered avatar if missing or stale. When set, a URL; empty or null when not.
>
> **ownerReply** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The business’s public reply to this review, if any.
>
> **replyState** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Google moderates owner replies asynchronously: PENDING until reviewed, then APPROVED or REJECTED. Synced from the Business Profile API; blank for manual rows or replies predating moderation visibility.
>
> **replyPolicyViolation** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The policy reason Google gave when it rejected the owner reply, if any.
>
> **stagedReply** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A reply drafted in the Google Business Dashboard and not yet pushed to Google. Managed by the dashboard’s Review & push flow, never edited here.
>
> **stagedReplyAction** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. What the staged reply will do when pushed: “reply” (create/update the owner reply) or “delete” (remove it). Blank when nothing is staged.
>
> **reviewUrl** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Permalink to the review on Google, when the provider supplies one. When set, a URL; empty or null when not.
>
> **source** `GoogleReviewSource | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Source. One of `manual`, `places-api`, `business-profile`, `demo`; a newer site may send others, so keep a fallback.
>
> **sourceId** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The review’s stable Google resource id — the de-duplication key set by a sync. Leave blank for manual entries.
>
> **gbpLocationId** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The Google Business Profile location this review belongs to (bare location id) — set by the Business Profile sync; ties the review to its gbp-location mirror row and the dashboard’s Reviews section.
>
> **archived** `boolean | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. In the archive: kept, but out of every list and off the site until it is restored. `false` (or null) for a live document.
>
> **createdAt** `Date | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. When it was created (ISO 8601). Format: an ISO 8601 date and time.
>
> **updatedAt** `Date | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. When it last changed (ISO 8601). Format: an ISO 8601 date and time.
>
> **aposShareKey** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The draft’s preview share key, while its share link is on: the link is the draft’s `_url` with `aposShareKey` and `aposShareId` (the draft’s `_id`) in its query. Absent otherwise, and on published documents.
>
> **pages** `number`
>
> **Always sent.** Pages in the whole list (0 when it is empty).
>
> **currentPage** `number`
>
> **Always sent.** This page, from 1.

> [accordion] Errors
>
> Nothing to catch: the SDK retries what is safe, and throws the rest as the classes below. Your exception handler turns them into your app’s own answers, once for every call (see [Map SDK errors to responses](https://docs.fetchski-attract.com/adonisjs/calling-the-api.md#map-sdk-errors-to-responses)); catch only what you want to react to here.
>
> **ValidationFailed** `400`
>
> The site refused what was sent: `errors` lists each field’s problem, `siteMessage` the first.
>
> **Retried first:** No. **Read:** `errors` (field → messages), `siteMessage`.
>
> **AuthenticationFailed** `401`
>
> The API key is missing or refused (malformed, revoked, expired), or a signature its signing mode needs is missing or stale.
>
> **Retried first:** No. **Read:** `siteMessage`, `errorName`, `data`.
>
> **Forbidden** `403`
>
> The key may not do this: a scope it lacks, or an address outside its allowlist. `siteMessage` names it.
>
> **Retried first:** No. **Read:** `siteMessage`, `errorName`, `data`.
>
> **NotFound** `404`
>
> Nothing matches, or the caller may not see it.
>
> **Retried first:** No. **Read:** `siteMessage`, `errorName`, `data`.
>
> **SiteError** `500`
>
> The site failed. Its logs say why.
>
> **Retried first:** No (only a 502, 503 or 504 is retried). **Read:** `siteMessage`, `errorName`, `data`.
>
> **SiteUnreachable** `no answer`
>
> No answer: DNS, a refused connection, TLS, or the timeout (15 s per attempt by default).
>
> **Retried first:** Yes, after 0.5 s then 1 s. **Read:** `reason`, `neverConnected`.
>
> **RequestNotSent** `not sent`
>
> The client refused to send it (e.g. a path segment of `..`); the site never saw it.
>
> **Retried first:** No. **Read:** `reason` (what to change).
>
> **SiteRequestFailed** `any other`
>
> Any other status, or a success whose JSON doesn’t match this SDK version’s types (update the SDK).
>
> **Retried first:** No. **Read:** `reason`, `status`.
>
> **UnknownSite** `setup`
>
> `sites.forSite('acme')` named a slug `config/attract.ts` doesn’t list (with the keys in the database: no row in `attract_api_keys`).
>
> **Retried first:** No: nothing was sent. **Read:** `message`, `slug`.
>
> **SiteConfigurationError** `setup`
>
> The site’s entry is wrong: a malformed `baseUrl` or key, a key filed under another slug, or no default site. `node ace attract:check` names the fix.
>
> **Retried first:** No: nothing was sent. **Read:** `message` (what to fix).

## Behavior

* **Access:** an API key with `content:google-reviews:read` (or a master above it: `content:google-reviews:all`, `content:all`, `admin:all`) reads the published documents; drafts (`aposMode=draft`) need `content:google-reviews:write` (or a master above it). A signed-in person reads as far as their own permissions allow, and anyone else reads the published documents’ public fields.
* **Rate limit:** the key’s own reads-per-minute limit, set when the key is created (default 600); over it, 429 with `Retry-After`. The client waits and retries for you; you see `RateLimited` only if that runs out.
* **Retries:** a read is safe to repeat: the client retries it on no answer, a 502/503/504 and a 429.
* **Timeout:** 15 s per attempt by default; raise `timeout` (milliseconds) in `config/attract.ts` for longer.
* **Paging:** one page per call. To walk them all, use `listGoogleReviewsAll()` (see More examples): it asks for the next page as you iterate, and stops after page `pages`.

## More examples

`listGoogleReviewsAll()` takes `listGoogleReviews()`’s arguments except `page`. `listGoogleReviewsPick()` takes the same arguments except `page`, after the fields to answer: each row is the document’s `id` and those fields.

```ts Every page wrap theme={"dark"}
import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
for await (const googleReview of site.googleReviews().listGoogleReviewsAll()) {
  console.log(googleReview) // the next page is fetched as you iterate
}
```

```ts Only some fields wrap theme={"dark"}
import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
const rows = await site.googleReviews().listGoogleReviewsPick(['title', 'slug']) // [{ id, title, slug }, …]: every Google review, across every page
```

## Test it

It calls the controller above with the SDK faked: `fakeAttract()` puts the fake in the container for this one test, and it answers every call with a valid example, so nothing leaves your machine and no key is read. Save it as `tests/unit/google_reviews_list_google_reviews.spec.ts`, then run your tests:

```ts tests/unit/google_reviews_list_google_reviews.spec.ts theme={"dark"}
import { test } from '@japa/runner'
import app from '@adonisjs/core/services/app'
import { fakeAttract } from '@fetchski/attract-cms-adonis/testing'
import ListGoogleReviewsController from '#controllers/list_google_reviews_controller'

test('googleReviews.listGoogleReviews', async () => {
  const site = fakeAttract()

  const controller = await app.container.make(ListGoogleReviewsController)
  await controller.handle()

  site.assertCalled('googleReviews.listGoogleReviews')
})
```

```bash Terminal theme={"dark"}
node ace test
```

**Answer with your own values:** fake `googleReviews.listGoogleReviews` with a `sequence()` of pages, each `factories.GoogleReviewList({...})`, and walk `listGoogleReviewsAll()`.

```ts tests/unit/google_reviews_list_google_reviews_answers.spec.ts theme={"dark"}
import { test } from '@japa/runner'
import { factories, fakeAttract, sequence } from '@fetchski/attract-cms-adonis/testing'

test('googleReviews.listGoogleReviews answers your values', async ({ assert }) => {
  const site = fakeAttract({
    'googleReviews.listGoogleReviews': sequence(
      factories.GoogleReviewList({ currentPage: 1, pages: 2 }),
      factories.GoogleReviewList({ currentPage: 2, pages: 2 })
    ),
  })

  const walked: unknown[] = []
  for await (const googleReview of site.googleReviews().listGoogleReviewsAll()) {
    walked.push(googleReview)
  }
  assert.lengthOf(walked, 2)
})
```

To fake `listGoogleReviewsAll()`, answer `googleReviews.listGoogleReviews` (the walk calls it page by page): a `sequence()` of answers for several pages.

## Related

> [card] [List a Google review’s locales](https://docs.fetchski-attract.com/adonisjs/reference/google-reviews/get-google-review-locales.md)
>
> `site.googleReviews().getGoogleReviewLocales()`

> [card] [Create a Google review](https://docs.fetchski-attract.com/adonisjs/reference/google-reviews/create-google-review.md)
>
> `site.googleReviews().createGoogleReview()`

> [card] [Get a Google review](https://docs.fetchski-attract.com/adonisjs/reference/google-reviews/get-google-review.md)
>
> `site.googleReviews().getGoogleReview()`

> [card] [Replace a Google review](https://docs.fetchski-attract.com/adonisjs/reference/google-reviews/replace-google-review.md)
>
> `site.googleReviews().replaceGoogleReview()`

> [card] [Delete a Google review](https://docs.fetchski-attract.com/adonisjs/reference/google-reviews/delete-google-review.md)
>
> `site.googleReviews().deleteGoogleReview()`

> [card] [Update a Google review](https://docs.fetchski-attract.com/adonisjs/reference/google-reviews/update-google-review.md)
>
> `site.googleReviews().updateGoogleReview()`

> [card] [GET /google-review](https://docs.fetchski-attract.com/api-reference/google-reviews/list-google-reviews.md)
>
> The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.