Returning list of all Retire Requests

GET /api/v1/contracts/retire/requests

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

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

Permission: Permissions.CONTRACTS_RETIRE_REQUEST_READ


Request

Query Parameters

Parameter
Type
Required
Default
Description

contractId

string

No

Filter requests by contract identifier

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 requests available

Error Responses

Status
Description

401 Unauthorized

Missing or invalid token

403 Forbidden

Insufficient permissions

500 Internal Server Error

Unexpected server failure

Last updated

Was this helpful?