← API v2 Overview

Reviews

Manage your business customer reviews. Create, update, approve and delete reviews, set the star rating (out of 5), reviewer name, review text, source and review date, and mark reviews as verified. Reviews are approved (live) by default; set the status to pending to hold one for moderation. Only approved reviews appear on the public website. List and read endpoints include pending reviews.

The Review Object

Generated from the OpenAPI schema. Always matches the live API.

Fields (9)
AttributeTypeRequiredDescriptionExample
idinteger-8821
ratingnumber-Star rating out of 5 (0-5, in 0.5 increments).4.5
namestring-Reviewer / customer name.John Smith
reviewstring-Review text.Excellent service, would buy again.
sourcestring-Where the review came from (max 32 chars), e.g. Google, AutoTrader.Google
verifiedboolean-Whether the review is marked as verified.true
statusenum-Approval status. Only approved reviews appear on the public website.approved
datestring (date) or null-Review date (YYYY-MM-DD).2026-05-20
dataobject-Source metadata (e.g. imported review details). Read-only; full view only.
Example object
{
    "id": 8821,
    "rating": 4.5,
    "name": "John Smith",
    "review": "Excellent service, would buy again.",
    "source": "Google",
    "verified": true,
    "status": "approved",
    "date": "2026-05-20",
    "data": {}
}

Endpoints

GET List Reviews

GET /2.0/reviews · scope reviews:read

List customer reviews with pagination and optional filters (status, source, verified).

Parameters (8)
ParameterInTypeRequiredDescriptionExample
pagequeryinteger-Page number, starting at 1 (offset pagination).
per_pagequeryinteger-Results per page (maximum 500).
viewqueryenum-simple (default for lists) or full (includes source metadata).
statusqueryenum-Filter by approval status.approved
sourcequerystring-Filter by source. Exact match, or use % for wildcard matching (minimum 3 characters).Google
verifiedqueryinteger-Filter by verified flag (0 or 1).
cursorquerystring-Keyset pagination cursor from a previous response's meta.pagination.next_cursor. When supplied, page/total are not returned.
fieldsquerystring-Comma-separated dot-paths to return only those fields, e.g. id,data.stock.price_channel.
Responses
StatusDescription
200 OKPaginated reviews

Failures use the standard error responses (4xx/5xx) with the shared error envelope.

{
    "success": true,
    "data": [
        {
            "id": 8821,
            "rating": 4.5,
            "name": "John Smith",
            "review": "Excellent service, would buy again.",
            "source": "Google",
            "verified": true,
            "status": "approved",
            "date": "2026-05-20",
            "data": {}
        }
    ],
    "meta": {
        "pagination": {
            "page": 0,
            "per_page": 0,
            "total": 0,
            "total_pages": 0,
            "next_cursor": ""
        }
    }
}

POST Create Review

POST /2.0/reviews · scope reviews:write

Create a customer review. Reviews are approved (live) by default; set status to pending to hold for moderation.

Request body
AttributeTypeRequiredDescriptionExample
ratingnumber-Star rating out of 5 (0-5, in 0.5 increments).4.5
namestring-Reviewer / customer name.John Smith
reviewstring-Review text.Excellent service, would buy again.
sourcestring-Where the review came from (max 32 chars).Google
verifiedboolean-Mark the review as verified.true
statusenum-Approval status. New reviews are approved by default; set to pending to hold for moderation. Only approved reviews show on the public website.approved
datestring (date)-Review date (YYYY-MM-DD). Defaults to today on create.2026-05-20
{
    "rating": 4.5,
    "name": "John Smith",
    "review": "Excellent service, would buy again.",
    "source": "Google",
    "verified": true,
    "status": "approved",
    "date": "2026-05-20"
}
Responses
StatusDescription
201 CreatedReview created

Failures use the standard error responses (4xx/5xx) with the shared error envelope.

{
    "success": true,
    "data": {
        "id": 8821,
        "rating": 4.5,
        "name": "John Smith",
        "review": "Excellent service, would buy again.",
        "source": "Google",
        "verified": true,
        "status": "approved",
        "date": "2026-05-20",
        "data": {}
    }
}

GET Get Review

GET /2.0/reviews/{id} · scope reviews:read

Retrieve a single review by id (includes pending reviews).

Parameters (2)
ParameterInTypeRequiredDescriptionExample
idpathstringYesResource identifier in the path.
fieldsquerystring-Comma-separated dot-paths to return only those fields, e.g. id,data.stock.price_channel.
Responses
StatusDescription
200 OKGet Review

Failures use the standard error responses (4xx/5xx) with the shared error envelope.

{
    "success": true,
    "data": {
        "id": 8821,
        "rating": 4.5,
        "name": "John Smith",
        "review": "Excellent service, would buy again.",
        "source": "Google",
        "verified": true,
        "status": "approved",
        "date": "2026-05-20",
        "data": {}
    }
}

PATCH Update Review

PATCH /2.0/reviews/{id} · scope reviews:write

Update a review, including approving or un-approving it. Only the supplied fields are changed.

Parameters (1)
ParameterInTypeRequiredDescriptionExample
idpathstringYesResource identifier in the path.
Request body
AttributeTypeRequiredDescriptionExample
ratingnumber-Star rating out of 5 (0-5, in 0.5 increments).4.5
namestring-Reviewer / customer name.John Smith
reviewstring-Review text.Excellent service, would buy again.
sourcestring-Where the review came from (max 32 chars).Google
verifiedboolean-Mark the review as verified.true
statusenum-Approval status. New reviews are approved by default; set to pending to hold for moderation. Only approved reviews show on the public website.approved
datestring (date)-Review date (YYYY-MM-DD). Defaults to today on create.2026-05-20
{
    "rating": 4.5,
    "name": "John Smith",
    "review": "Excellent service, would buy again.",
    "source": "Google",
    "verified": true,
    "status": "approved",
    "date": "2026-05-20"
}
Responses
StatusDescription
200 OKUpdate Review

Failures use the standard error responses (4xx/5xx) with the shared error envelope.

{
    "success": true,
    "data": {
        "id": 8821,
        "rating": 4.5,
        "name": "John Smith",
        "review": "Excellent service, would buy again.",
        "source": "Google",
        "verified": true,
        "status": "approved",
        "date": "2026-05-20",
        "data": {}
    }
}

DELETE Delete Review

DELETE /2.0/reviews/{id} · scope reviews:delete

Delete a review.

Parameters (1)
ParameterInTypeRequiredDescriptionExample
idpathstringYesResource identifier in the path.
Responses
StatusDescription
200 OKDelete Review

Failures use the standard error responses (4xx/5xx) with the shared error envelope.

{
    "success": true,
    "data": {
        "id": 0,
        "deleted": false
    }
}