Company token transactions

List company token transactions

Changed on

Lists an account's token transactions, newest first.

Required permissions:

  • company_token_transaction:read
  • member:basic:read
  • company:basic:read
get/company_token_transactions

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/company_token_transactions
  • Auth: HTTP bearer

Query parameters

afterstring

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

beforestring

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

firstinteger

Returns the first n elements from the list.

Example:42
lastinteger

Returns the last n elements from the list.

Example:42
user_idstring

Filter transactions to only those involving this specific user.

Example:user_xxxxxxxxxxxxx
transaction_type'add' | 'subtract' | 'transfer'

The type of token transaction

account_idstring required

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

Example:biz_xxxxxxxxxxxxxx

Response

A successful response

Example response

{
  "data": [
    {
      "amount": 6.9,
      "company": {
        "id": "biz_xxxxxxxxxxxxxx"
      },
      "created_at": "2023-12-01T05:00:00.401Z",
      "description": "Reward for completing onboarding",
      "idempotency_key": "txn_reward_usr_123_2024",
      "user": {
        "id": "user_xxxxxxxxxxxxx",
        "name": "John Doe",
        "username": "johndoe42"
      }
    }
  ]
}

Changes

  • 697924df40d1Revision changes
    • breaking

      added the new required query request parameter account_id

    • warning

      deleted the query request parameter company_id

  • f67a043e3190Revision changes
    • breaking

      the query request parameter transaction_type was restricted to a list of enum values

    • info

      added the new enum value add to the query request parameter transaction_type

    • info

      added the new enum value subtract to the query request parameter transaction_type

    • info

      added the new enum value transfer to the query request parameter transaction_type

    • info

      for the query request parameter transaction_type, the type was generalized from no type to string