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

# Get Business Reviews

> Retrieve paginated customer reviews for your business using the Willro API.

Retrieve a paginated list of customer reviews for your business.

<Note>
  Use this endpoint to display customer feedback and ratings in your dashboard
  or reports.
</Note>

***

## Onboarding Guide

This API lets you fetch reviews posted about your business. Results are paginated, so you can load reviews page by page.

### Requirements

* A valid API key passed in the `x-api-key` header
* HTTPS requests only
* Keep your API key secure and private

***

## Endpoint

GET /integration/business-api/reviews

**Base URL:** `https://api.willro.com/api/v1`

***

## Authentication

<ParamField header="x-api-key" type="string" required>
  Your Willro API key. You can find it in your Willro dashboard under Developer

  > API Keys:
  > `willro_live_sk_95ad4a1e-48ac-4872-ae02-0d40072b60bf_6b7ec4b3af7911a65ee1c3a5ce3fe84b8c2e34136ca71030`
</ParamField>

***

## Query Parameters

| Name      | Type   | Required | Description                                                                                                                                          |
| --------- | ------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| page      | number | No       | Page number for pagination (default: 1)                                                                                                              |
| limit     | number | No       | Number of reviews per page (default: 10)                                                                                                             |
| mediaType | string | No       | Filter reviews by media type. One of: `IMAGE`, `TEXT`, `VIDEO`.                                                                                      |
| sortType  | string | No       | Sort by relevance, rating, or recency. One of: `MOST_RELEVANT`, `HIGHEST_REVIEWS`, `LOWEST_REVIEWS`, `RECENT_REVIEWS`, `RECENT_WITH_MIN_ONE_REVIEW`. |
| rating    | number | No       | Filter by rating value. Must be between `1` and `5`.                                                                                                 |

***

## Request Example

<CodeGroup>
  ```js theme={null}
  const page = 1;
  const limit = 10;
  const mediaType = 'TEXT';
  const sortType = 'MOST_RELEVANT';
  const rating = 3;

  const url = new URL('https://api.willro.com/api/v1/integration/business-api/reviews');
  url.searchParams.set('page', String(page));
  url.searchParams.set('limit', String(limit));
  url.searchParams.set('mediaType', mediaType);
  url.searchParams.set('sortType', sortType);
  url.searchParams.set('rating', String(rating));

  const response = await fetch(url.toString(), {
  method: 'GET',
  headers: {
  'x-api-key': 'YOUR_API_KEY',
  'Content-Type': 'application/json'
  }
  });

  const data = await response.json();
  console.log(data);

  ```
</CodeGroup>

## Response Example

```js theme={null}
{
  "links": {
    "self": "/api/v1/integration/business-api/reviews?limit=10&page=1&rating=3&sortBy=createdAt&sortType=MOST_RELEVANT"
  },
  "pagination": {
    "page": 1,
    "limit": 10,
    "totalItems": 5,
    "totalPages": 1
  },
  "data": [
    {
      "author": {
        "name": "John Doe",
        "picture": "https://example.com/avatar.jpg",
        "username": "johndoe",
        "isVerified": true,
        "totalReview": 10
      },
      "business": {
        "businessName": "ExampleCo",
        "logo": "https://example.com/logo.png",
        "website": "https://example.com",
        "category": "Retail",
        "averageRating": 3.2,
        "totalReview": 12,
        "isVerified": true
      },
      "rating": 3,
      "content": "Test review for engagement 1",
      "views": 6000,
      "layout": "CLASSIC",
      "publishedAt": "2025-12-07T04:00:14.761Z",
      "id": "6934fbc2f42d4678c9bd97a5",
      "reactions": 1,
      "topReactions": ["AGREE"],
      "comments": 50,
      "shares": 50,
      "location": "London, Uk",
      "media": {
        "url": "https://example.com/image1.jpg",
        "type": "IMAGE",
        "thumbnailUrl": "https://example.com/thumb1.jpg"
      }
    }
  ]
}
```