Skip to main content
GET
List opportunities

Authorizations

Authorization
string
header
required

A paid-team API key, sent as Authorization: Bearer rch_live_…. Create and revoke keys in the app under Settings → API keys.

Query Parameters

query
string

Free-text match across the opportunity's review.

status
enum<string>

Filter by triage status. Only new is accepted as a filter.

Available options:
new
product
string<uuid>

Restrict to opportunities whose review is for this product id (uuid).

rating
string

Comma-separated review ratings, e.g. 4,5.

Example:

"4,5"

platform
string

Comma-separated sources to include, at either level: a review site (g2, capterra, trustpilot, trustradius, sourceforge) or a social source (linkedin, reddit). Mix freely, e.g. g2,linkedin. Omit for everything the team's plan entitles.

Example:

"g2,linkedin"

industry
string

Comma-separated company industries.

size
string

Comma-separated company sizes.

country
string

Comma-separated company countries.

created_after
string<date-time>

Inclusive lower bound on created_at (ISO 8601).

created_before
string<date-time>

Inclusive upper bound on created_at (ISO 8601).

sort
enum<string>
default:newest

Sort order by creation time.

Available options:
newest,
oldest
page
integer
default:1

1-indexed page number.

Required range: x >= 1
page_size
integer
default:20

Items per page (max 100).

Required range: 1 <= x <= 100

Response

A page of opportunities.

success
boolean
required
data
object[]
required
meta
object
required