Skip to main content
GET
/
opportunities
List opportunities
curl --request GET \
  --url https://app.reechee.io/api/v1/opportunities \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "is_viewed": true,
      "status": "new",
      "created_at": "2023-11-07T05:31:56Z",
      "review": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "platform": "<string>",
        "reviewer_name": "<string>",
        "reviewer_title": "<string>",
        "reviewer_company": "<string>",
        "enriched_company_name": "<string>",
        "enriched_company_logo": "<string>",
        "rating": 123,
        "review_url": "<string>",
        "published_at": "2023-11-07T05:31:56Z",
        "company_industry": "<string>",
        "company_size": "<string>",
        "company_country": "<string>",
        "product": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "logo_url": "<string>"
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "page_size": 20,
      "has_more": true
    }
  }
}

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 review platforms, e.g. g2,capterra (lowercase).

Example:

"g2,capterra"

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