Skip to main content
GET
/
company_token_transactions
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 companyTokenTransactionListResponse of client.companyTokenTransactions.list({
  company_id: 'biz_xxxxxxxxxxxxxx',
})) {
  console.log(companyTokenTransactionListResponse.id);
}
{
  "data": [
    {
      "id": "<string>",
      "transaction_type": "add",
      "amount": 6.9,
      "description": "Reward for completing onboarding",
      "created_at": "2023-12-01T05:00:00.401Z",
      "linked_transaction_id": "<string>",
      "idempotency_key": "txn_reward_usr_123_2024",
      "user": {
        "id": "user_xxxxxxxxxxxxx",
        "name": "John Doe",
        "username": "johndoe42"
      },
      "member": {
        "id": "<string>"
      },
      "company": {
        "id": "biz_xxxxxxxxxxxxxx",
        "title": "<string>",
        "route": "<string>"
      }
    }
  ],
  "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

company_id
string
required

The unique identifier of the company to list token transactions for.

Example:

"biz_xxxxxxxxxxxxxx"

user_id
string | null

Filter transactions to only those involving this specific user.

Example:

"user_xxxxxxxxxxxxx"

transaction_type
enum<string> | null

Filter transactions by type.

Available options:
add,
subtract,
transfer

Response

A successful response

The connection type for CompanyTokenTransaction.

data
object[]
required

A list of nodes.

page_info
object
required

Information to aid in pagination.