Retrieve Bounty

Retrieves a bounty by ID. Authentication is optional: a request with no credential reads the bounty when it is publicly visible — published or completed, and not restricted to a private experience’s members. Bounties outside the caller’s scope, and bounties not publicly visible to an anonymous caller, return 404.

GET /bounties/{id}

JavaScript

JavaScript

import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

const bounty = await client.bounties.retrieve('id');

console.log(bounty.id);

200

{
  "accepted_deliverable_types": [
    "data_capture"
  ],
  "accepted_submissions_count": 0,
  "accepted_submissions_limit": 3,
  "accepted_submissions_per_user_limit": 1,
  "affiliate_share_amount": 5.6,
  "allowed_country_codes": [
    "US"
  ],
  "budget_amount": 120,
  "business_goal_type": "data_capture",
  "cancel_requested_at": "2026-01-01T12:00:00.000Z",
  "capture_spec": {
    "filename_pattern": "Country_City_Site_Station_Operator",
    "imu": {
      "device_motion_units": "ua=m/s²,gv=g,r=rad/s,q=unit",
      "magnetometer_units": "µT",
      "min_rate_hz": 90,
      "target_rate_hz": 100,
      "warmup_min_rate_hz": 45,
      "warmup_ns": 3000000000
    },
    "manifest_schema_version": 2,
    "min_clip_duration_seconds": 120,
    "min_total_verified_duration_seconds": 14400,
    "required_metadata_fields": [
      "country"
    ],
    "single_continuous_take": true,
    "video": {
      "bitrate_ceiling_mbps": 50,
      "bitrate_floor_mbps": 4,
      "bitrate_target_mbps": 12,
      "camera_lens": "ultra_wide",
      "codecs": [
        "h264"
      ],
      "embed_camera_metadata": false,
      "fps": 30,
      "frame_gap_tolerance_ms": 1000,
      "height": 1080,
      "min_fov_degrees": 130,
      "orientation": "landscapeRight",
      "preferred_fov_degrees": 140,
      "stabilization_mode": "off",
      "stabilization_required": false,
      "width": 1920
    }
  },
  "created_at": "2026-01-01T12:00:00.000Z",
  "currency": "usd",
  "description": "Record one continuous pass of a full interior detail, dash to trunk, on a customer vehicle.",
  "discussion_experience_id": "<string>",
  "discussion_feed_id": "<string>",
  "discussion_post_id": "<string>",
  "experience_id": "exp_xxxxxxxxxxxxxx",
  "funding_account": {
    "id": "biz_xxxxxxxxxxxxxx",
    "title": "Shine Time Auto Detailing"
  },
  "gross_paid_out_amount": 0,
  "gross_reward_amount": 40,
  "hosting_account": {
    "id": "biz_xxxxxxxxxxxxxx",
    "route": "shine-time-auto-detailing",
    "title": "Shine Time Auto Detailing"
  },
  "id": "bnty_xxxxxxxxxxxxxx",
  "net_reward_amount": 28,
  "poster": {
    "id": "user_xxxxxxxxxxxxxx",
    "name": "Dana Whitfield",
    "profile_picture": {
      "url": "https://ui-avatars.com/api/"
    },
    "username": "danawhitfield"
  },
  "scheduled_frequency": "weekly",
  "scheduled_publish_at": "2026-01-01T12:00:00.000Z",
  "spots_remaining": 3,
  "status": "scheduled",
  "submissions_closed_at": "2026-01-01T12:00:00.000Z",
  "title": "Record interior detailing passes",
  "unresolved_submissions_count": 0,
  "updated_at": "2026-01-01T12:00:00.000Z",
  "viewer_accepted_submissions_count": 0
}

Authorizations

Authorization · string · header · required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Headers

Api-Version-Date · string

Pins the request to a dated API version.

Example:

"2026-08-21"

Path Parameters

id · string · required

Bounty ID (bnty_ tag).

Response

200

application/json

bounty retrieved

accepted_deliverable_types · enum<string>[] · required

The deliverable shapes this bounty accepts. Every bounty accepts any combination of content_url (posted links) and media (uploaded files), except data_capture bounties, whose proof is clips recorded in the Whop app that accumulate on the attempt.

Available options: content_url, media, data_capture

accepted_submissions_count · integer · required

Submissions accepted so far.

Example:

0

accepted_submissions_limit · integer · required

Number of submissions that can be accepted (winner slots).

Example:

3

accepted_submissions_per_user_limit · integer · required

How many winner slots one worker can win. Defaults to 1. Wins plus proofs awaiting review never exceed this number, and a worker runs one attempt at a time. Cannot exceed accepted_submissions_limit.

Example:

1

affiliate_share_amount · number · required

What a referrer earns per accepted submission when the worker arrived through their affiliate link, in whole currency units, at the standard platform fee rate. Taken out of the worker's post-fee reward rather than added on top. 0 when the bounty pays no affiliate share, including bounties tied to no account, which cannot record a referral.

Example:

5.6

allowed_country_codes · string[] · required

Countries whose residents can work the bounty, as ISO 3166 alpha-2 codes. Empty means worldwide.

budget_amount · number · required

Total gross budget committed to the bounty: gross_reward_amount times accepted_submissions_limit.

Example:

120

business_goal_type · enum<string> | null · required

What the poster wants the work to achieve, declared once at create. null for bounties created before the taxonomy rolled out.

Available options: clipping, post_engagement, owned_account_growth, ugc_content, local_activation, data_capture, other, null

Example:

"data_capture"

cancel_requested_at · string | null · required

When cancellation was requested, as an ISO 8601 timestamp. On a closed bounty this means the cancel is pending: submissions are stopped and the bounty cancels once in-flight submissions resolve. On a canceled bounty it records when the cancellation was requested. null when no cancellation was ever requested.

Example:

"2026-01-01T12:00:00.000Z"

capture_spec · object | null · required

The technical contract footage must be recorded against. Present only on data_capture bounties; null for every other goal type.

Show child attributes

created_at · string · required

When the bounty was created, as an ISO 8601 timestamp.

Example:

"2026-01-01T12:00:00.000Z"

currency · enum<string> · required

Currency for all amounts on the bounty, as a lowercase ISO 4217 code.

Available options: usd, sgd, inr, aud, brl, cad, dkk, eur, nok, gbp, sek, chf, hkd, huf, jpy, mxn, myr, pln, czk, nzd, aed, cop, ron, thb, bgn, idr, dop, php, try, krw, twd, vnd, pkr, clp, uyu, ars, zar, dzd, tnd, mad, kes, kwd, jod, all, xcd, amd, bsd, bhd, bob, bam, khr, crc, xof, egp, etb, gmd, ghs, gtq, gyd, ils, jmd, mop, mga, mur, mdl, mnt, nad, ngn, mkd, omr, pyg, pen, qar, rwf, sar, rsd, lkr, tzs, ttd, uzs, rub, cny, kzt, awg

Example:

"usd"

description · string · required

Full task instructions shown to workers.

Example:

"Record one continuous pass of a full interior detail, dash to trunk, on a customer vehicle."

discussion_experience_id · string | null · required

Experience the bounty's discussion thread lives in, prefixed exp_. Read this — not experience_id — to open the thread: a platform-wide bounty has no hosting experience of its own but its discussion still lives in one.

discussion_feed_id · string | null · required

Forum feed containing the bounty's discussion thread. null for a bounty with no forum post.

discussion_post_id · string | null · required

Forum post anchoring the bounty's discussion thread. Read together with discussion_experience_id to address the thread. null for a bounty with no forum post.

experience_id · string | null · required

Experience the bounty is hosted in, prefixed exp_. null for platform-wide bounties; may belong to a different account than the funder.

Example:

"exp_xxxxxxxxxxxxxx"

funding_account · object | null · required

Account whose balance funds the bounty pool, or null when a user funds it personally. May differ from the account hosting experience_id.

Show child attributes

gross_paid_out_amount · number · required

Gross amount paid out from the bounty pool across accepted submissions — worker payouts, platform fees, and affiliate shares together. Tips and reviewer rewards are excluded.

Example:

0

gross_reward_amount · number · required

Gross bounty-pool amount allocated per accepted submission, in whole currency units.

Example:

40

hosting_account · object | null · required

Account hosting the bounty's forum — the one whose route and experience_id address its discussion thread, and where its submissions dashboard lives. null for a platform-wide bounty with no host. May differ from funding_account.

Show child attributes

id · string · required

Bounty ID, prefixed bnty_.

Example:

"bnty_xxxxxxxxxxxxxx"

net_reward_amount · number · required

What a worker is quoted per accepted submission after the platform fee, in whole currency units. The exact post-fee figure, at the standard platform fee rate — a worker who locked a different rate, or who arrived through an affiliate link, is paid a different amount.

Example:

28

poster · object · required

User who posted the bounty — the account owner when created with an account API key.

Show child attributes

scheduled_frequency · enum<string> | null · required

How often the schedule creates a new bounty. Each occurrence is a separate bounty; the original is not republished.

Available options: once, hourly, daily, weekly, monthly, null

Example:

"weekly"

scheduled_publish_at · string | null · required

When a scheduled bounty will publish, as an ISO 8601 timestamp. null once published, for bounties that were never scheduled, and for terminally failed drafts parked for manual rescheduling.

Example:

"2026-01-01T12:00:00.000Z"

spots_remaining · integer · required

Unfilled winner capacity: accepted_submissions_limit minus accepted_submissions_count, clamped to zero. Not on its own a signal that the bounty accepts new claims — read status for that: only an open bounty takes new submissions.

Example:

3

status · enum<string> · required

Lifecycle state. scheduled bounties are unpublished drafts, visible to their poster and the account's authorized managers; open bounties accept new submissions; closed bounties are live but no longer accept new submissions; completed bounties paid out every winner slot; canceled bounties ended before filling their slots.

Available options: scheduled, open, closed, completed, canceled

Example:

"scheduled"

submissions_closed_at · string | null · required

When new submissions stopped being accepted, as an ISO 8601 timestamp. Set when a cancellation is requested on a bounty with work in flight, so in-flight submissions can resolve before the bounty cancels. null when submissions were never stopped — including completed bounties that simply filled every winner slot.

Example:

"2026-01-01T12:00:00.000Z"

title · string · required

Short name of the task shown to workers.

Example:

"Record interior detailing passes"

unresolved_submissions_count · integer · required

Submissions still awaiting an outcome: in progress or pending review.

Example:

0

updated_at · string · required

When the bounty was last updated, as an ISO 8601 timestamp.

Example:

"2026-01-01T12:00:00.000Z"

viewer_accepted_submissions_count · integer · required

How many winner slots the authenticated user has already won on this bounty. Read against accepted_submissions_per_user_limit to show a worker their remaining allowance. 0 when the request has no authenticated user.

Example:

0