> ## Documentation Index > Fetch the complete documentation index at: https://docs.whop.com/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve Bounty Submission > Retrieves one bounty submission the credential can see — one the caller authored, or one on a bounty they posted or their account owns. ## OpenAPI ````yaml /openapi/api-v1-native.json get /bounty_submissions/{bounty_submission_id} openapi: 3.1.0 info: description: >- The Whop REST API. Please see https://docs.whop.com/developer/api/getting-started for more details. termsOfService: https://whop.com/tos-developer-api/ title: Whop API version: 1.0.0 x-api-version-date: '2026-07-20' servers: - description: Production Whop API url: https://api.whop.com/api/v1 - description: Sandbox Whop API url: https://sandbox-api.whop.com/api/v1 security: [] tags: - description: > An Account represents a person or business on Whop that can have its own profile, wallet, and account-scoped settings. Use accounts for customers, creators, merchants, sellers, or connected businesses your integration supports. Use the Accounts API to create accounts, list accounts visible to your credentials, retrieve or update an account, and retrieve the account associated with the current API key. name: Accounts x-whop-summary: 'A business on Whop: profile, wallet, capabilities, settings.' - description: > A User represents a person on Whop. Users have a public profile and can buy products, join accounts, and access experiences. Use the Users API to search for users, retrieve or update profiles, and check whether a user has access to an account, product, or experience. name: Users x-whop-summary: 'A person on Whop: profile and connected identities.' - description: > A Team Member is a member of an account's team: the link between a user and an account, carrying the role that controls what they can do. Roles are either system roles (like `admin` or `moderator`) or `custom` roles managed from the dashboard. Use the Team Members API to list an account's team, add a user to the team with a system role, change a member's role, and remove members. Adding a user who has not yet accepted sends an invitation instead. name: Team Members x-whop-summary: An account's team members and the roles that scope their access. - name: Webhooks x-whop-summary: Event notifications pushed to your server as things happen. - description: > Stats represent aggregated activity for an account over time. They help you understand revenue, transactions, disputes, members, referrals, and advertising performance across reporting periods like days, weeks, or months. Use the Stats API to list available metrics and their filterable properties, then retrieve time-series values for a date range. name: Stats x-whop-summary: Aggregated financial, audience, and traffic reporting. - description: > A Ledger Activity row is a single financial event on an account's ledger — a payment, withdrawal, refund, transfer, on-chain deposit, swap, or card transaction. Each row is derived from the underlying ledger lines and carries a typed `resource` and `source` so you can present and link the event without extra lookups. Use Ledger Activity to build a statement or transaction feed for an account or user. Reconcile against your own records with `amount` (signed, in the currency's smallest precision units) and `posted_at`, and use `available_at` to know when inflows became withdrawable. name: Ledgers x-whop-summary: The activity feed behind an account or user's balance. - description: > Payouts represent money sent from an account or user balance to an external destination, such as a bank account, wallet, or other saved payout method. Use the Payouts API to create payouts from stablecoin accounts, list payout history for accounts or users, monitor payout statuses, and show expected arrival details for funds leaving Whop. name: Payouts x-whop-summary: Send money from a balance to a bank or wallet. - description: > Cards represent Whop-issued virtual payment cards that spend from an account or user balance. Cards can be assigned to cardholders and configured with spending limits for controlled spending. Use the Cards API to issue cards, list cards for an account or user, and retrieve active card details such as the card number and CVC. name: Cards x-whop-summary: Issue cards that spend from a balance. - description: > Transfers move value between identities on Whop. They are used for account-to-account money movement, user payouts inside Whop, crypto transfers, and claim links depending on the destination type. Use the Transfers API to create a transfer, list previous transfers, and retrieve a transfer by ID when reconciling money movement between accounts or users. name: Transfers x-whop-summary: Move funds between Whop accounts and users. - description: > Deposits describe ways to add funds to an account balance, including hosted deposit pages, bank deposit instructions, and supported crypto wallet addresses. Use the Deposits API to create deposit instructions for an account. name: Deposits x-whop-summary: Add funds to a balance. - description: > Swaps convert value between supported tokens, chains, or wallet destinations for an account. A swap quote describes the expected output, fees, and approval requirements before you create the swap. Use the Swaps API to quote a conversion, create the swap, list recent swaps, and retrieve status until the transaction completes. name: Swaps x-whop-summary: Convert a balance between currencies. - description: > A Verification represents a legal identity for a person or business. Accounts and users complete verification when Whop needs to confirm who they are before enabling payouts or compliance-sensitive workflows. Use the Verifications API to start or resume a hosted verification session, check review status, and submit requested details or documents. If `requested_information` contains items, submit answers with [Update Verification](/api-reference/beta/verifications/update-verification). name: Verifications x-whop-summary: Legal identity required before payouts and card issuing. - description: > A Product is a digital good or service sold on Whop. Products may contain plans for pricing and/or experiences for content delivery. Use the Products API to create products, list products visible to your credentials, retrieve product details, update product metadata or merchandising fields, and delete products that should no longer be sold. name: Products x-whop-summary: The things you sell. Each owns plans and a store page. - description: > A Plan defines how customers buy a product. It controls pricing, billing cadence, availability, tax behavior, checkout fields, and purchase visibility. Use the Plans API to create plans for products, list existing plans, retrieve or update plan configuration, calculate tax for checkout, and delete plans that should no longer be offered. name: Plans x-whop-summary: 'Pricing for a product: one-time, recurring, trials, stock.' - description: > A Checkout Configuration is a reusable checkout link owned by an account. In `payment` mode it sells a specific plan; in `setup` mode it collects and saves payment details without charging. Each configuration can also override which payment methods are accepted and how 3D Secure is enforced for that checkout. Use the Checkout Configurations API to create checkout links for an existing or inline plan, list configurations for an account, retrieve the configuration behind a checkout URL, and delete links that should no longer be used. name: Checkout Configurations x-whop-summary: Turn a plan into a shareable, prefilled checkout link. - description: > The Partners API covers your Whop partner activity: the users you referred onto Whop, the businesses you referred and the earnings generated from their processing volume, and the partner leaderboard. Use it to enroll as a Whop partner, list the users you referred, list your referred businesses and review their earnings, and see the partner leaderboard. name: Partners x-whop-summary: >- The users and businesses you referred to Whop, and what you earn from them. - description: > A Bounty is a paid task posted by an account or user. The reward is held in escrow when the bounty publishes, workers submit proof of completed work, and each accepted submission is paid out until every winner slot fills. Use the Bounties API to create and publish a bounty, list an account's bounties for reporting or dashboards, list the bounties a user can work or has participated in, and retrieve a single bounty by ID. name: Bounties x-whop-summary: Paid tasks with reviewed submissions and escrowed rewards. - description: > A Bounty Submission is one worker's attempt on a bounty. It starts as an in-progress attempt, enters the review queue when proof is submitted, and ends approved (paid from the bounty's escrowed pool) or denied. Use the Bounty Submissions API to submit proof of completed work to a bounty, list the submissions you authored, and review the submissions on your bounties — across every bounty or narrowed to one. name: Bounty Submissions x-whop-summary: Work submitted to a bounty, from attempt to payout. - description: > A Person represents a visitor or customer of an account, assembled from [pixel events](/api-reference/beta/events/event) and purchase activity — ad clicks, storefront visits, and checkouts. Use the People API to list the people of an account and retrieve a single person. name: People x-whop-summary: Visitors and customers of an account, aggregated from pixel events. - description: > An Event records conversion or engagement activity for an account, such as page views, purchases, or leads. Each event ties the action to the [person](/api-reference/beta/people/person) who took it, so activity can be attributed to the ads and links that drove it. Use the Events API to send new tracking events, list recent identity-linked events for an account, and inspect the events recorded for a person. name: Events x-whop-summary: Conversion and engagement events tracked for attribution. - description: > An Ad is the individual creative unit delivered by an [ad group](/api-reference/beta/ad-groups/ad-group). It holds the copy, creative assets, and destination URL for one ad. Use the Ads API to list ads for an account, create ads inside ad groups, retrieve or update creative details, delete ads that should stop running, and pause or resume delivery. name: Ads x-whop-summary: 'The creative: copy, assets, and destination URL.' - description: > An Ad Campaign is the top-level container for paid ads on an ad network. It sets the platform, objective, and budget strategy shared by its [ad groups](/api-reference/beta/ad-groups/ad-group) and ads. Use the Ad Campaigns API to create campaigns, list campaigns for an account, retrieve or update campaign settings, and pause or resume campaign delivery. name: Ad Campaigns x-whop-summary: Platform, objective, and budget for a set of ads. - description: > An Ad Group sits inside an [ad campaign](/api-reference/beta/ad-campaigns/ad-campaign) and controls delivery for [ads](/api-reference/beta/ads/ad). It sets the audience, placements, schedule, budget, and optimization goal for its ads. Use the Ad Groups API to create ad groups in campaigns, list or retrieve targeting and delivery settings, update budgets or targeting, delete groups that should stop running, and pause or resume delivery. It can also search the ad platform's targeting taxonomy for options to target and estimate how many people a draft targeting spec can reach. name: Ad Groups x-whop-summary: Audience, placements, and schedule within a campaign. - description: > An Audience represents a customer list uploaded to Whop for ad targeting. Audiences belong to an account and sync to supported ad platforms as custom audiences. Use the Audiences API to create audiences from CSV uploads, monitor processing status, and list or delete audiences for an account. Created audiences are usable for targeting after processing reaches `ready` or `partial`. name: Audiences x-whop-summary: Reusable targeting lists for ad groups. - description: > A Media Asset is an AI-generated image or video created from a prompt and billed from an account balance. When generation finishes, the asset includes a file that can be attached anywhere Whop accepts files. Use the Media API to start a generation job and retrieve the asset while it processes or after it is ready. name: Media x-whop-summary: >- AI-generated assets, billed from a balance, attachable wherever files are accepted. - description: > A Social Account represents an external profile connected to a Whop account or user, such as a Facebook page or Instagram account. Connecting a social account lets Whop run [ads](/api-reference/beta/ads/ad) under that profile's identity and promote its existing posts. Use the Social Accounts API to list connected accounts, create a Whop-managed Facebook page, start an OAuth connection, disconnect a social account, and list a connected profile's posts or a Facebook page's lead forms. name: Social Accounts x-whop-summary: Connected Facebook and Instagram accounts that run ads. - description: > An App is software you build on Whop. It can be a hosted web app served at `.whop.app` or an API integration installed as an experience, and it belongs to the account that owns its credentials, settings, builds, and runtime logs. Use the Apps API to manage app configuration and, for hosted apps, read server runtime logs for console output, uncaught exceptions, and failed requests. Logs are retained for 7 days and can be filtered by build, level, time window, and message text. name: Apps x-whop-summary: 'Apps you build on Whop: metadata, hosted builds, runtime logs.' - description: > An App Build is a versioned artifact uploaded for an app — a hosted web archive, or an iOS/Android bundle. Builds start as drafts, go through review, and one approved build per platform is served to users as the production build. Use the App Builds API to upload a build for an app, list an app's builds with platform and status filters, retrieve a build, and promote a draft or approved build to production. name: App Builds x-whop-summary: Versioned build artifacts deployed to an app's platforms. - description: > An API Key is a programmatic credential owned by an account or app. Each key carries its own permissions policy — explicit permission statements or an inherited system role — and can be restricted with an expiration date and an IP allowlist. Use the API Keys API to list a company or app's keys, create a key (the full secret is returned once, on creation), inspect a key's effective grants, update its name or restrictions, rotate its secret, and revoke it. These endpoints require a user session — they cannot be called with an API key. name: API Keys x-whop-summary: Programmatic credentials for an account or app. paths: /bounty_submissions/{bounty_submission_id}: parameters: - $ref: '#/components/parameters/ApiVersionDate' - description: The bounty submission to act on (`btys_` tag). in: path name: bounty_submission_id required: true schema: type: string get: tags: - Bounty Submissions summary: Retrieve Bounty Submission description: >- Retrieves one bounty submission the credential can see — one the caller authored, or one on a bounty they posted or their account owns. operationId: retrieveBountySubmission responses: '200': content: application/json: schema: $ref: '#/components/schemas/BountySubmission' description: bounty submission returned '401': $ref: '#/components/responses/Unauthorized' description: missing credentials '404': $ref: '#/components/responses/NotFound' description: submission not visible to the credential security: - bearerAuth: - bounty:basic:read x-codeSamples: - lang: JavaScript source: >- import Whop from '@whop/sdk'; const client = new Whop({ apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted }); const bountySubmission = await client.bountySubmissions.retrieve('bounty_submission_id'); console.log(bountySubmission.id); components: parameters: ApiVersionDate: description: Pins the request to a dated API version. in: header name: Api-Version-Date required: false schema: example: '2026-07-20' type: string schemas: BountySubmission: properties: bounty_id: description: The bounty the work was submitted to, prefixed `bnty_`. type: string capture_clips: items: $ref: '#/components/schemas/BountyCaptureClip' description: >- The submission's capture clips in recording order, each carrying its own review `status` and temporary signed artifact URLs. The full deliverable when `deliverable_type` is `data_capture`, populated only on single-submission reads; `null` on list responses (use `captured_clip_count` and `captured_duration_seconds` for the summary) and for other deliverable types. type: - array - 'null' capture_filename: description: >- The vendor filename stem `Country_City_Site_Station_Operator`, derived from the capture metadata. `null` until every component is present. type: - string - 'null' captured_clip_count: description: >- Number of verified capture clips accepted for this submission so far. `0` for submissions whose deliverable doesn't accumulate clips. type: integer captured_duration_seconds: description: >- Total verified duration of accepted capture clips, in whole seconds. `0` for submissions whose deliverable doesn't accumulate clips. type: integer city: description: >- Capture metadata: city the footage was recorded in. `null` unless capture metadata was provided. type: - string - 'null' content: description: Written proof the worker submitted with their work. type: - string - 'null' country: description: >- Capture metadata: country the footage was recorded in. `null` unless capture metadata was provided. type: - string - 'null' created_at: description: When the submission was created, as an ISO 8601 timestamp. type: string deliverable_type: description: >- Which of the bounty's `accepted_deliverable_types` this submission used. Branch on it to read the work: `content_url` and `media` carry `deliverable_urls`; `data_capture` carries `capture_clips`. `null` on submissions authored before deliverable types existed. enum: - content_url - media - data_capture - null example: content_url type: - string - 'null' deliverable_urls: items: description: >- The submitted work as URLs: the posted content links for `content_url` deliverables, or temporary download URLs for the uploaded files of `media` deliverables. `null` for `data_capture` submissions, whose deliverable is `capture_clips`. type: string type: - array - 'null' denial_reason: description: >- Why the submission was denied, when a presentable reason exists. Always `null` unless `status` is `denied`. type: - string - 'null' device: description: >- Capture metadata: device the footage was recorded on. `null` unless capture metadata was provided. type: - string - 'null' fov: description: >- Capture metadata: horizontal field of view in degrees. `null` when not reported. type: - integer - 'null' id: description: Submission ID, prefixed `btys_`. type: string operator: description: >- Capture metadata: identifier of the person who recorded the footage. `null` unless capture metadata was provided. type: - string - 'null' resolved_at: description: >- When the submission was approved or denied, as an ISO 8601 timestamp. `null` until then. type: - string - 'null' site: description: >- Capture metadata: site or venue the footage was recorded at. `null` unless capture metadata was provided. type: - string - 'null' station: description: >- Capture metadata: station or position within the site. `null` unless capture metadata was provided. type: - string - 'null' status: description: >- Lifecycle state. `in_progress` submissions are active attempts that have not submitted proof yet; `submitted` submissions await review; `approved` submissions were accepted and paid; `denied` submissions were rejected. enum: - in_progress - submitted - approved - denied example: in_progress type: string submitted_at: description: >- When proof was submitted for review, as an ISO 8601 timestamp. `null` while the attempt is in progress. type: - string - 'null' updated_at: description: When the submission was last updated, as an ISO 8601 timestamp. type: string worker: $ref: '#/components/schemas/UserSummary' description: User who submitted the work. required: - id - bounty_id - status - deliverable_type - deliverable_urls - captured_clip_count - captured_duration_seconds - capture_clips - content - denial_reason - submitted_at - resolved_at - country - city - site - station - operator - device - fov - capture_filename - created_at - updated_at - worker type: object BountyCaptureClip: properties: bounty_submission_id: description: >- The bounty submission (attempt) this clip belongs to, prefixed `btys_`. type: string created_at: description: When the clip was created, as an ISO 8601 timestamp. type: string duration_seconds: description: >- Server-validated clip duration in whole seconds. `null` until validation completes. type: - integer - 'null' failure_code: description: Stable validation failure code. `null` unless `status` is `failed`. type: - string - 'null' failure_message: description: >- Human-readable validation failure reason. `null` unless `status` is `failed`. type: - string - 'null' frames_url: description: >- Temporary signed URL for the video frame timestamp log. Returned only on single-clip reads for an authorized viewer; `null` on list responses or until the artifact is attached. type: - string - 'null' id: description: Capture clip ID, prefixed `bclip_`. type: string imu_url: description: >- Temporary signed URL for the IMU (accelerometer + gyroscope) log. Returned only on single-clip reads for an authorized viewer; `null` on list responses or until the artifact is attached. type: - string - 'null' manifest_url: description: >- Temporary signed URL for the capture manifest. Returned only on single-clip reads for an authorized viewer; `null` on list responses or until the artifact is attached. type: - string - 'null' ready_at: description: >- When server-side validation completed successfully, as an ISO 8601 timestamp. `null` until then. type: - string - 'null' sequence: description: The clip's stable order within the attempt, starting at 1. type: integer status: description: >- Recording and validation state. `recording` is still capturing; `verifying` is running server-side validation; `ready` passed validation and counts toward the verified-duration payout gate; `failed` did not validate. enum: - recording - verifying - ready - failed example: recording type: string updated_at: description: When the clip was last updated, as an ISO 8601 timestamp. type: string video_url: description: >- Temporary signed URL for the synchronized MP4 video. Returned only on single-clip reads for an authorized viewer; `null` on list responses or until the artifact is attached. type: - string - 'null' required: - id - bounty_submission_id - sequence - status - duration_seconds - failure_code - failure_message - ready_at - video_url - imu_url - frames_url - manifest_url - created_at - updated_at type: object UserSummary: properties: id: description: User ID, prefixed `user_`. type: string name: description: Display name. type: - string - 'null' profile_picture: $ref: '#/components/schemas/UserProfilePicture' description: >- Avatar wrapper; its `url` is always present, using a generated placeholder when the user set no picture. username: description: Public username. type: string required: - id - username - name - profile_picture type: object V1ErrorResponse: properties: error: properties: message: description: Human-readable error message. type: string type: description: Machine-readable error code. type: string required: - type - message type: object required: - error type: object UserProfilePicture: properties: url: description: >- Avatar image URL. Always present — a generated placeholder when the user set no picture. type: string required: - url type: object responses: Unauthorized: content: application/json: schema: $ref: '#/components/schemas/V1ErrorResponse' description: Unauthorized NotFound: content: application/json: schema: $ref: '#/components/schemas/V1ErrorResponse' description: Resource not found securitySchemes: bearerAuth: bearerFormat: auth-scheme description: >- A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like `Bearer ***************************` scheme: bearer type: http ````