List bounties

Returns a paginated list of workforce bounties. When experienceId is provided, returns bounties scoped to that experience. When omitted, returns bounties with no experience.

GET /bounties

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
});

// Automatically fetches more pages as needed.
for await (const bountyListResponse of client.bounties.list()) {
  console.log(bountyListResponse.id);
}

200

{
  "data": [
    {
      "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"
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "start_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true
  }
}

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

Query Parameters

after · string | null

Returns the elements in the list that come after the specified cursor.

before · string | null

Returns the elements in the list that come before the specified cursor.

first · integer | null

Returns the first n elements from the list.

Example:

42

last · integer | null

Returns the last n elements from the list.

Example:

42

experience_id · string | null

The experience to list bounties for. When omitted, returns bounties with no experience.

Example:

"exp_xxxxxxxxxxxxxx"

status · enum<string> | null

Filter bounties by status.

Available options: published, archived

direction · enum<string> | null

Sort direction. Defaults to descending.

Available options: asc, desc

Response

200

application/json

A successful response

The connection type for Bounty.

data · object[] · required

A list of nodes.

Show child attributes

page_info · object · required

Information to aid in pagination.

Show child attributes