List Rents By Token

Returns the rent payouts recorded for the user on one token, newest first. A payout row is written for every holder who held at least the token's min_tokens_required_for_rental_income when the operator distributed a rent deposit. Take a row's external_id as the rent_id to claim it.

A user with no payout on the token gets an empty page, not a 404.

Required permission: rent:view

Request

GET /v2/users/{user_id}/rents/tokens/{token_id}

Parameters

Name	Type	In	Description
user_id	string	path	Required. User ID
token_id	string	path	Required. Token ID
page	integer	query	Required. Page number, starting at 1
per_page	integer	query	Required. Items per page, 1–100

Headers

Name	Description
Authorization	Required. Bearer <access_token>

Example

curl --request GET \
  --url '{{baseUrl}}/v2/users/680c02896d91ca0145cfeb81/rents/tokens/68ae06cfcccf4e8fc19362d1?page=1&per_page=10' \
  --header 'Authorization: Bearer <access_token>'

Response

{
  "data": [
    {
      "id": "6913c40155654191dede3810",
      "user_id": "680c02896d91ca0145cfeb81",
      "token_id": "68ae06cfcccf4e8fc19362d1",
      "deposit_id": "6913c3f855654191dede380e",
      "external_id": 1,
      "total_price": {
        "id": "6913307ec95e268b239b2d8b",
        "amount": "2.5",
        "decimal": 6,
        "symbol": "VUSD",
        "address": "0xf2d90affe805280c004d0135343f2cbd7c96ce98"
      },
      "per_price": {
        "id": "6913307ec95e268b239b2d8b",
        "amount": "0.1",
        "decimal": 6,
        "symbol": "VUSD",
        "address": "0xf2d90affe805280c004d0135343f2cbd7c96ce98"
      },
      "contract_created_at": null,
      "created_at": "2026-11-09T09:40:03Z",
      "updated_at": "2026-11-09T09:40:03Z"
    }
  ],
  "total": 1,
  "page": 1,
  "per_page": 10
}

Response Fields

Field	Type	Description
data[].id	string	Payout row ID
data[].user_id	string	Holder the payout belongs to
data[].token_id	string	Token the rent was paid on
data[].deposit_id	string	Rent deposit the payout comes from
data[].external_id	integer	On-chain ID of the rent deposit. Send it as rent_id to Claim Rent
data[].total_price	object | null	The user's payout: per_price × whole tokens held at distribution. {id, amount, decimal, symbol, address}, amount is a decimal string
data[].per_price	object | null	Rent per token, same shape
data[].contract_created_at	string | null	On-chain creation time when recorded (RFC 3339)
data[].created_at	string	When the payout was recorded (RFC 3339)
data[].updated_at	string	Last change (RFC 3339)
total	integer	Number of payout rows
page	integer	Requested page
per_page	integer	Requested page size

The rows do not say whether a payout was already claimed. A claim of an already claimed payout is refused with 10002 (see Claim Rent).

Errors

Status	Code	Description
400	10015	Validation failed (page, per_page) — see details
400	10016	user_id or token_id is not a valid 24-character hex id
500	10000	Unexpected server-side failure

See Errors for the error format and common codes.