---
title: "Review Rewards API Reference"
description: "Three months of the Pro plan for free in exchange for an honest review of Linkbreakers on G2, Capterra or Trustpilot."
canonical: "https://linkbreakers.com/help/api/review-rewards"
---

# Review Rewards

Three months of the Pro plan for free in exchange for an honest review of Linkbreakers on G2, Capterra or Trustpilot.

## Review Rewards

## [#](#review-rewards-object)The ReviewReward object

A review a member submitted in exchange for free Pro months.

decidedAt

string (date-time)

When the team approved or disregarded it.

id

string

platform

string (enum)

ReviewPlatform is a site where Linkbreakers can be reviewed.

##### Allowed values

`REVIEW_PLATFORM_UNSPECIFIED`

Not specified

`REVIEW_PLATFORM_G2`

G2 (g2.com)

`REVIEW_PLATFORM_CAPTERRA`

Capterra (capterra.com)

`REVIEW_PLATFORM_TRUSTPILOT`

Trustpilot (trustpilot.com)

reviewUrl

string

Link to the review on the platform.

reviewerName

string

The name the review was posted under, to help find it.

rewardEndsAt

string (date-time)

When the free Pro months end, once approved.

status

string (enum)

ReviewRewardStatus is where a submitted review stands.

##### Allowed values

`REVIEW_REWARD_STATUS_UNSPECIFIED`

Not specified

`REVIEW_REWARD_STATUS_PENDING`

Submitted, waiting for the Linkbreakers team to check the review exists

`REVIEW_REWARD_STATUS_APPROVED`

The review was found and the free Pro months were granted

`REVIEW_REWARD_STATUS_DISREGARDED`

The review could not be found or was not written by this person

submittedAt

string (date-time)

Example object

```json
{
  "decidedAt": "2026-10-31T15:18:00.871Z",
  "id": "string",
  "platform": "REVIEW_PLATFORM_UNSPECIFIED",
  "reviewUrl": "https://example.com",
  "reviewerName": "string",
  "rewardEndsAt": "2026-10-31T15:18:00.871Z",
  "status": "REVIEW_REWARD_STATUS_UNSPECIFIED",
  "submittedAt": "2026-10-31T15:18:00.871Z"
}
```

GET

`/v1/review-rewards/offer`

Requires auth

## [#](#get-the-review-reward-offer)Get the review reward offer

Return whether the workspace can claim free Pro months for a review, the Linkbreakers page on each review site, and the latest review it submitted. Requires the \`workspace:read\` scope.

### [#](#get-the-review-reward-offer-parameters)Parameters

This endpoint does not accept any parameters.

### [#](#get-the-review-reward-offer-response)Response

200

Everything worked as expected.

eligible

boolean

Whether the workspace can submit a review for the reward now.

ineligibleReason

string (enum)

ReviewRewardIneligibleReason says why a workspace cannot take the offer.

##### Allowed values

`REVIEW_REWARD_INELIGIBLE_REASON_UNSPECIFIED`

Not specified: the workspace is eligible

`REVIEW_REWARD_INELIGIBLE_REASON_PAID_PLAN`

The workspace already pays for a plan or is on Enterprise or sponsored Pro

`REVIEW_REWARD_INELIGIBLE_REASON_ALREADY_REWARDED`

The workspace already received free Pro months for a review

latest

object

A review a member submitted in exchange for free Pro months.

platforms

array<object>

The Linkbreakers page on each review site.

rewardMonths

integer (int32)

How many months of Pro the reward gives.

### [#](#get-the-review-reward-offer-error)Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

object

Required

Wrapped error response.

Example request (cURL)

```bash
curl -X GET "https://api.linkbreakers.com/v1/review-rewards/offer" \
  -H "Authorization: Bearer YOUR_TOKEN"
```

Typical response

```json
{
  "eligible": false,
  "ineligibleReason": "REVIEW_REWARD_INELIGIBLE_REASON_UNSPECIFIED",
  "latest": {
    "decidedAt": "2026-10-31T15:18:00.861Z",
    "id": "string",
    "platform": "REVIEW_PLATFORM_UNSPECIFIED",
    "reviewUrl": "https://example.com",
    "reviewerName": "string",
    "rewardEndsAt": "2026-10-31T15:18:00.861Z",
    "status": "REVIEW_REWARD_STATUS_UNSPECIFIED",
    "submittedAt": "2026-10-31T15:18:00.861Z"
  },
  "platforms": [
    {
      "name": "string",
      "platform": "REVIEW_PLATFORM_UNSPECIFIED",
      "url": "https://example.com"
    }
  ],
  "rewardMonths": 0
}
```

Base URL: `https://api.linkbreakers.com`

POST

`/v1/review-rewards`

Requires auth

## [#](#submit-a-review-for-the-reward)Submit a review for the reward

Record a review posted on G2, Capterra or Trustpilot. The Linkbreakers team checks it exists and was written by the member, whatever its rating, then grants the free Pro months. Requires the \`workspace:write\` scope.

### [#](#submit-a-review-for-the-reward-parameters)Parameters

#### header parameters

Idempotency-Key

string

header

Makes retrying this request safe. See components.parameters.IdempotencyKey.

### [#](#submit-a-review-for-the-reward-request)Request body

platform

string (enum)

ReviewPlatform is a site where Linkbreakers can be reviewed.

##### Allowed values

`REVIEW_PLATFORM_UNSPECIFIED`

Not specified

`REVIEW_PLATFORM_G2`

G2 (g2.com)

`REVIEW_PLATFORM_CAPTERRA`

Capterra (capterra.com)

`REVIEW_PLATFORM_TRUSTPILOT`

Trustpilot (trustpilot.com)

reviewUrl

string

Link to the posted review on that platform.

reviewerName

string

The name the review was posted under.

### [#](#submit-a-review-for-the-reward-response)Response

200

Everything worked as expected.

reviewReward

object

A review a member submitted in exchange for free Pro months.

### [#](#submit-a-review-for-the-reward-error)Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

object

Required

Wrapped error response.

Example request (cURL)

```bash
curl -X POST "https://api.linkbreakers.com/v1/review-rewards" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Idempotency-Key: string" \
  -H "Content-Type: application/json" \
  --data '{"platform":"REVIEW_PLATFORM_UNSPECIFIED","reviewUrl":"https://example.com","reviewerName":"string"}'
```

Sample payload (application/json)

```json
{
  "platform": "REVIEW_PLATFORM_UNSPECIFIED",
  "reviewUrl": "https://example.com",
  "reviewerName": "string"
}
```

Typical response

```json
{
  "reviewReward": {
    "decidedAt": "2026-10-31T15:18:00.861Z",
    "id": "string",
    "platform": "REVIEW_PLATFORM_UNSPECIFIED",
    "reviewUrl": "https://example.com",
    "reviewerName": "string",
    "rewardEndsAt": "2026-10-31T15:18:00.861Z",
    "status": "REVIEW_REWARD_STATUS_UNSPECIFIED",
    "submittedAt": "2026-10-31T15:18:00.861Z"
  }
}
```

Base URL: `https://api.linkbreakers.com`

---

Source: https://linkbreakers.com/help/api/review-rewards