Returning list of all Retire Pools

GET /api/v1/contracts/retire/pools

Returns a paginated list of all retire pools. Accessible by Standard Registry and User roles.

Authentication: Bearer token required (Authorization: Bearer <token>)

Permission: Permissions.CONTRACTS_POOL_READ

---

Request

Query Parameters

Parameter	Type	Required	Default	Description
contractId	string	No	—	Filter pools by contract identifier
tokens	string	No	—	Comma-separated list of token identifiers to filter by
pageIndex	number	No	0	The number of pages to skip before starting to collect the result
pageSize	number	No	20	The number of items to return

---

Response

Success Response

Status: 200 OK

Headers:

Header	Description
X-Total-Count	Total number of retire pools available

[
  {
    "id": "63e3e5e8a01b3c001234abcd",
    "contractId": "0.0.4532001",
    "tokens": [
      {
        "token": "0.0.5000001",
        "count": 100
      }
    ],
    "enabled": true
  }
]

Error Responses

Status	Description
401 Unauthorized	Missing or invalid token
403 Forbidden	Insufficient permissions
500 Internal Server Error	Unexpected server failure