OpenAPI 3.1.02026-08-213914255.9 MB
715c4defcbbf
Company token transactions
List company token transactions
Returns a paginated list of token transactions for a user or company, depending on the authenticated actor, with optional filtering by user and transaction type.
Required permissions:
- company_token_transaction:read
- member:basic:read
- company:basic:read
get/company_token_transactions
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
company_idstring required
The unique identifier of the company to list token transactions for.
Example:biz_xxxxxxxxxxxxxx
user_idstring
Filter transactions to only those involving this specific user.
Example:user_xxxxxxxxxxxxx
transaction_type'add' | 'subtract' | 'transfer'
The type of token transaction
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"
}
}
]
}