> ## Documentation Index > Fetch the complete documentation index at: https://docs.reechee.io/llms.txt > Use this file to discover all available pages before exploring further. # List opportunities > The team's latest opportunities with filters and pagination. Requires an API key. Sorted by `created_at` (recency). Each row is either review-sourced or social-sourced: `source` says which (`"review"`, `"linkedin"`, or `"reddit"`), `review` is populated for the former and `mention` for the latter. Social sources (LinkedIn, Reddit) require a Scale plan or higher - they are simply absent from the response on lower plans. ## OpenAPI ````yaml /openapi.yaml get /opportunities openapi: 3.1.0 info: title: Reechee Developer Platform API version: 1.0.0 description: > The Reechee REST API exposes software-review pain points, buying signals, and sales opportunities. Two auth lanes share one base URL: - **Anonymous** (no key) - read-only, IP rate-limited. Product search, a free pain-points taste, and category competitors. - **API key** (`Authorization: Bearer rch_live_…`) - paid teams get full pain-point reports, opportunities, watchlist, credit balance, and safe write actions (follow/unfollow, triage). Every response uses a consistent envelope: `{ "success": true, "data": … }` on success (with an optional `meta`), or `{ "success": false, "error": { "code", "message", "details"? } }` on failure. contact: name: Reechee url: https://reechee.io servers: - url: https://app.reechee.io/api/v1 description: Production security: [] tags: - name: System description: Health and connectivity. - name: Products description: Search products and read their pain points and competitors. - name: Opportunities description: Read and triage sales opportunities (API key required). - name: Watchlist description: Read and manage the team's followed products (API key required). - name: Account description: Team account data such as credit balance (API key required). - name: Credits description: >- Credit-spending actions (Tier 3). Requires a spend budget on the credential - a per-key spend cap for API keys, or the consent-time credit budget for OAuth connections. paths: /opportunities: get: tags: - Opportunities summary: List opportunities description: > The team's latest opportunities with filters and pagination. Requires an API key. Sorted by `created_at` (recency). Each row is either review-sourced or social-sourced: `source` says which (`"review"`, `"linkedin"`, or `"reddit"`), `review` is populated for the former and `mention` for the latter. Social sources (LinkedIn, Reddit) require a Scale plan or higher - they are simply absent from the response on lower plans. operationId: listOpportunities parameters: - name: query in: query description: Free-text match across the opportunity's review. schema: type: string - name: status in: query description: Filter by triage status. Only `new` is accepted as a filter. schema: type: string enum: - new - name: product in: query description: >- Restrict to opportunities whose review is for this product id (uuid). schema: type: string format: uuid - name: rating in: query description: Comma-separated review ratings, e.g. `4,5`. schema: type: string example: 4,5 - name: platform in: query description: > 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. schema: type: string example: g2,linkedin - name: industry in: query description: Comma-separated company industries. schema: type: string - name: size in: query description: Comma-separated company sizes. schema: type: string - name: country in: query description: Comma-separated company countries. schema: type: string - name: created_after in: query description: Inclusive lower bound on `created_at` (ISO 8601). schema: type: string format: date-time - name: created_before in: query description: Inclusive upper bound on `created_at` (ISO 8601). schema: type: string format: date-time - name: sort in: query description: Sort order by creation time. schema: type: string enum: - newest - oldest default: newest - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' responses: '200': description: A page of opportunities. content: application/json: schema: type: object required: - success - data - meta properties: success: type: boolean const: true data: type: array items: $ref: '#/components/schemas/Opportunity' meta: type: object required: - pagination properties: pagination: $ref: '#/components/schemas/PaginationMeta' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '429': $ref: '#/components/responses/RateLimited' security: - bearerAuth: [] components: parameters: Page: name: page in: query required: false description: 1-indexed page number. schema: type: integer minimum: 1 default: 1 PageSize: name: page_size in: query required: false description: Items per page (max 100). schema: type: integer minimum: 1 maximum: 100 default: 20 schemas: Opportunity: type: object required: - id - is_viewed - status - created_at - source properties: id: type: string format: uuid is_viewed: type: boolean status: type: string example: new created_at: type: string format: date-time source: type: string description: > Which of `review` / `mention` is populated: `"review"` for a software review, `"linkedin"` or `"reddit"` for a social mention. Deliberately an open string, not an enum - the review site itself lives on `review.platform`, not here. example: review mention: anyOf: - $ref: '#/components/schemas/OpportunityMention' - type: 'null' review: anyOf: - $ref: '#/components/schemas/OpportunityReviewSummary' - type: 'null' PaginationMeta: type: object required: - page - page_size - has_more properties: page: type: integer example: 1 page_size: type: integer example: 20 has_more: type: boolean example: true OpportunityMention: type: object description: | A social mention (LinkedIn or Reddit post), normalized across the two platforms. LinkedIn populates `author_headline` / `author_title` / `author_company_*`; Reddit populates `subreddit` and puts the handle in `author_name`. `url` is the post permalink. properties: url: type: - string - 'null' posted_at: type: - string - 'null' format: date-time sentiment: type: - string - 'null' has_buying_signal: type: - boolean - 'null' pain_points: type: - object - 'null' additionalProperties: true author_name: type: - string - 'null' author_headline: type: - string - 'null' author_title: type: - string - 'null' author_company_name: type: - string - 'null' author_company_logo: type: - string - 'null' subreddit: type: - string - 'null' product: anyOf: - $ref: '#/components/schemas/OpportunityProduct' - type: 'null' OpportunityReviewSummary: type: object properties: id: type: string format: uuid platform: type: string reviewer_name: type: - string - 'null' reviewer_title: type: - string - 'null' reviewer_company: type: - string - 'null' enriched_company_name: type: - string - 'null' enriched_company_logo: type: - string - 'null' rating: type: - number - 'null' review_url: type: - string - 'null' published_at: type: string format: date-time company_industry: type: - string - 'null' company_size: type: - string - 'null' company_country: type: - string - 'null' product: anyOf: - $ref: '#/components/schemas/OpportunityProduct' - type: 'null' ErrorResponse: type: object required: - success - error properties: success: type: boolean const: false error: type: object required: - code - message properties: code: type: string enum: - invalid_request - unauthorized - payment_required - forbidden - not_found - rate_limited - internal_error message: type: string details: type: - object - 'null' additionalProperties: true OpportunityProduct: type: object required: - id - name properties: id: type: string format: uuid name: type: string logo_url: type: - string - 'null' responses: BadRequest: description: The request was malformed. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: invalid_request message: Invalid request Unauthorized: description: A valid API key is required (or the key was invalid/revoked/expired). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: unauthorized message: API key required RateLimited: description: | The rate limit was exceeded. The response carries `Retry-After` and `X-RateLimit-*` headers. headers: Retry-After: description: Seconds to wait before retrying. schema: type: integer X-RateLimit-Limit: description: Requests allowed in the window. schema: type: integer X-RateLimit-Remaining: description: Requests remaining in the window. schema: type: integer X-RateLimit-Reset: description: Unix seconds when the window resets. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: rate_limited message: Rate limit exceeded details: retry_after_seconds: 12 limit: 60 remaining: 0 securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: rch_live_… description: > A paid-team API key, sent as `Authorization: Bearer rch_live_…`. Create and revoke keys in the app under Settings → API keys. ````