> ## 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. # Get an opportunity > Full detail for one opportunity. Requires an API key. Check `source` first: `"review"` populates `review` (reviewer, star rating, review text); `"linkedin"` / `"reddit"` populate `mention` (the post, its author, and the author's company - not unlock-gated, since a social author is already public). Unlock-gated fields - the reviewer's personal LinkedIn, email, and phone, and the buying committee - are redacted to `null` unless the team has unlocked them; the `is_*_revealed` flags and `buying_committee.is_revealed` tell you the state. ## OpenAPI ````yaml /openapi.yaml get /opportunities/{id} 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/{id}: get: tags: - Opportunities summary: Get an opportunity description: > Full detail for one opportunity. Requires an API key. Check `source` first: `"review"` populates `review` (reviewer, star rating, review text); `"linkedin"` / `"reddit"` populate `mention` (the post, its author, and the author's company - not unlock-gated, since a social author is already public). Unlock-gated fields - the reviewer's personal LinkedIn, email, and phone, and the buying committee - are redacted to `null` unless the team has unlocked them; the `is_*_revealed` flags and `buying_committee.is_revealed` tell you the state. operationId: getOpportunity parameters: - $ref: '#/components/parameters/OpportunityId' responses: '200': description: The opportunity detail (gated fields redacted unless unlocked). content: application/json: schema: type: object required: - success - data properties: success: type: boolean const: true data: $ref: '#/components/schemas/OpportunityDetail' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/RateLimited' security: - bearerAuth: [] components: parameters: OpportunityId: name: id in: path required: true description: Opportunity id (uuid). schema: type: string format: uuid schemas: OpportunityDetail: type: object required: - id - is_viewed - status - created_at - buying_committee - source properties: id: type: string format: uuid is_viewed: type: boolean is_committee_revealed: type: boolean is_reviewer_revealed: type: boolean is_reviewer_email_revealed: type: boolean is_reviewer_phone_revealed: type: boolean reviewer_email: type: - string - 'null' description: >- Null unless unlocked, and null when the unlock found nothing (see reviewer_email_not_found). reviewer_phone: type: - string - 'null' description: >- Null unless unlocked, and null when the unlock found nothing (see reviewer_phone_not_found). reviewer_email_not_found: type: boolean description: >- True when the email was unlocked but enrichment found nothing. Distinguishes a withheld value from a paid-for miss. reviewer_phone_not_found: type: boolean description: True when the phone was unlocked but enrichment found nothing. reviewer_email_source: type: - string - 'null' reviewer_phone_source: type: - string - 'null' buying_committee: $ref: '#/components/schemas/BuyingCommittee' status: type: string 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. example: review mention: anyOf: - $ref: '#/components/schemas/OpportunityDetailMention' - type: 'null' review: anyOf: - $ref: '#/components/schemas/OpportunityDetailReview' - type: 'null' BuyingCommittee: type: object required: - is_revealed properties: is_revealed: type: boolean members: type: - array - 'null' description: Null until the committee is unlocked; member objects once revealed. items: type: object additionalProperties: true OpportunityDetailMention: type: object description: > A social mention on the detail response: the list shape plus the post body and the author's public profile. The profile is not unlock-gated - a LinkedIn/Reddit author is already public, unlike a review's reviewer identity. properties: id: type: string format: uuid url: type: - string - 'null' text: 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_bio: type: - string - 'null' author_profile_url: type: - string - 'null' author_city: type: - string - 'null' author_country: type: - string - 'null' author_company_name: type: - string - 'null' author_company_logo: type: - string - 'null' author_company_linkedin_url: type: - string - 'null' author_company_website: type: - string - 'null' author_company_size: type: - string - 'null' author_company_industry: type: - string - 'null' author_company_description: type: - string - 'null' subreddit: type: - string - 'null' product: anyOf: - $ref: '#/components/schemas/OpportunityProduct' - type: 'null' OpportunityDetailReview: 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' reviewer_company_logo: type: - string - 'null' rating: type: - number - 'null' review_url: type: - string - 'null' linkedin_lead_url: type: - string - 'null' description: Reviewer's personal LinkedIn. Null unless the reviewer is unlocked. linkedin_company_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' company_description: type: - string - 'null' company_website: type: - string - 'null' enriched_company_name: type: - string - 'null' enriched_company_logo: type: - string - 'null' enriched_company_industry: type: - string - 'null' enriched_company_size: type: - string - 'null' enriched_company_country: type: - string - 'null' enriched_company_website: type: - string - 'null' enriched_company_linkedin: type: - string - 'null' enriched_reviewer_name: type: - string - 'null' enriched_reviewer_title: type: - string - 'null' enriched_reviewer_linkedin: type: - string - 'null' description: Null unless the reviewer is unlocked. enriched_reviewer_city: type: - string - 'null' enriched_reviewer_country: type: - string - 'null' pain_points_analysis: type: - object - 'null' additionalProperties: true 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: 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 NotFound: description: The resource was not found. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: not_found message: Resource not found 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. ````