Skip to main content
GET
/
bounties
/
{id}
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('bnty_xxxxxxxxxxxxx');

console.log(bounty.id);
{
  "id": "bnty_xxxxxxxxxxxxx",
  "title": "<string>",
  "description": "<string>",
  "total_available": 6.9,
  "total_paid": 6.9,
  "vote_threshold": 42,
  "created_at": "2023-12-01T05:00:00.401Z",
  "updated_at": "2023-12-01T05:00:00.401Z"
}

Authorizations

​
Authorization
string
header
required

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 ***************************

Path Parameters

​
id
string
required

The unique identifier of the workforce bounty to retrieve.

Example:

"bnty_xxxxxxxxxxxxx"

Response

A successful response

A privately accessible bounty.

​
id
string
required

The unique identifier for the bounty.

Example:

"bnty_xxxxxxxxxxxxx"

​
title
string
required

The title of the bounty.

​
description
string
required

The description of the bounty.

​
status
enum<string>
required

The current lifecycle status of the bounty.

Available options:
published,
archived
​
total_available
number
required

The total amount currently funded in the bounty pool for payout.

Example:

6.9

​
total_paid
number
required

The total amount paid out for this bounty.

Example:

6.9

​
currency
enum<string>
required

The currency used for the bounty funds.

Available options:
usd,
sgd,
inr,
aud,
brl,
cad,
dkk,
eur,
nok,
gbp,
sek,
chf,
hkd,
huf,
jpy,
mxn,
myr,
pln,
czk,
nzd,
aed,
eth,
ape,
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,
btc,
cny,
usdt,
kzt,
awg,
whop_usd,
xau
​
bounty_type
enum<string>
required

The underlying bounty implementation type.

Available options:
classic,
user_funded,
workforce
​
vote_threshold
integer
required

The number of watcher votes required before the submission can resolve.

Example:

42

​
created_at
string<date-time>
required

The datetime the bounty was created.

Example:

"2023-12-01T05:00:00.401Z"

​
updated_at
string<date-time>
required

The datetime the bounty was last updated.

Example:

"2023-12-01T05:00:00.401Z"