# List reviews

Returns reviews, one page at a time.

```http
GET https://api.pozy.ai/v1/inbox/reviews
```

- Area: Inbox / Reviews
- Auth: Authorization: Bearer pz_live_...

## Query parameters

- `profileId` (string)
- `platform` (string): one of facebook, googlebusiness
- `minRating` (integer)
- `maxRating` (integer)
- `hasReply` (boolean)
- `sortBy` (string): one of date, rating
- `sortOrder` (string): one of asc, desc
- `limit` (integer)
- `cursor` (string)
- `accountId` (string)

## Example request

```bash
curl -X GET "https://api.pozy.ai/v1/inbox/reviews?limit=25" \
  -H "Authorization: Bearer $POZY_API_KEY"
```

```ts
const res = await fetch("https://api.pozy.ai/v1/inbox/reviews?limit=25", {
  headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);
```

```python
import os
import requests

resp = requests.get(
    "https://api.pozy.ai/v1/inbox/reviews",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    params={
        "limit": 25,
    },
    timeout=30,
)
resp.raise_for_status()
print(resp.json())
```

## Response 200

- `status`, string
- `data`, array of object
  - `id`, string
  - `platform`, string
  - `accountId`, string
  - `accountUsername`, string
  - `locationId`, string
  - `locationName`, string: Can be null
  - `reviewer`, object
    - `id`, string: Can be null
    - `name`, string
    - `profileImage`, string: Can be null
  - `rating`, integer
  - `recommendationType`, string: One of `positive`, `negative`. Can be null
  - `text`, string
  - `created`, string (date-time)
  - `hasReply`, boolean
  - `hasPhotos`, boolean
  - `photoCount`, integer
  - `photos`, array of object
    - `url`, string (URL)
  - `reply`, object: Can be null
    - `id`, string
    - `text`, string
    - `created`, string (date-time)
  - `reviewUrl`, string: Can be null
- `pagination`, object
  - `hasMore`, boolean
  - `nextCursor`, string: Can be null
- `meta`, object
  - `accountsQueried`, integer
  - `accountsFailed`, integer
  - `failedAccounts`, array of object
    - `accountId`, string
    - `accountUsername`, string: Can be null
    - `platform`, string
    - `error`, string
    - `code`, string: Can be null
    - `retryAfter`, integer: Can be null
  - `lastUpdated`, string (date-time)
  - `accountsSkipped`, array of object
    - `accountId`, string
    - `platform`, string
- `summary`, object
  - `totalReviews`, integer
  - `averageRating`, number: Can be null

```json
{
  "status": "active",
  "data": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "platform": "instagram",
      "accountId": "696e0b682d0a31188e7a2ba9",
      "accountUsername": "acme",
      "locationId": "6e99c3dd69982b334a43b0b2",
      "locationName": "Acme",
      "reviewer": {
        "id": "6bfebd43ddc270f6d2c56fc5",
        "name": "Acme",
        "profileImage": "string"
      },
      "rating": 1,
      "recommendationType": "positive",
      "text": "Hello from Pozy",
      "created": "2026-10-02T09:00:00.000Z",
      "hasReply": true,
      "hasPhotos": true,
      "photoCount": 42,
      "photos": [
        {
          "url": "https://pozy.ai/media/example-1.jpg"
        }
      ],
      "reply": {
        "id": "6bfebd43ddc270f6d2c56fc5",
        "text": "Hello from Pozy",
        "created": "2026-10-02T09:00:00.000Z"
      },
      "reviewUrl": "https://pozy.ai/media/example-1.jpg"
    }
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "string"
  },
  "meta": {
    "accountsQueried": 42,
    "accountsFailed": 42,
    "failedAccounts": [
      {
        "accountId": "696e0b682d0a31188e7a2ba9",
        "accountUsername": "acme",
        "platform": "instagram",
        "error": "string",
        "code": "string",
        "retryAfter": 1
      }
    ],
    "lastUpdated": "2026-10-02T09:00:00.000Z",
    "accountsSkipped": [
      {
        "accountId": "696e0b682d0a31188e7a2ba9",
        "platform": "instagram"
      }
    ]
  },
  "summary": {
    "totalReviews": 42,
    "averageRating": 12.5
  }
}
```