Sign in

v50

latestOpenAPI 3.0.0The Radix License, Version 1.0raw.githubusercontent.com2026-04-0736336265.6 KB
Extensions

Get entities by role requirement page

Paginated endpoint returns a page of global entities that have ever used the provided requirement (such as a resource or non-fungible global ID) in their access rules (blueprint authentication templates, owner roles, or role assignments). This endpoint allows querying by a single requirement. By default it returns up to 100 entries are returned per response. This limit can be increased to a maximum of 1000 entries per page using the limit_per_page parameter. To retrieve subsequent pages, use the returned cursor and call the /extensions/entities-by-role-requirement/page endpoint.

To lookup multiple requirements, please call the /extensions/entities-by-role-requirement/lookup endpoint.

Behaviour:

  • Entities are returned in ascending order by the state version in which the requirement was first observed on the ledger.
  • It may include entities that no longer use the requirement as part of an access rule.
  • If no entities are found, an empty list will be returned.
post/extensions/entities-by-role-requirement/page

Request body

cursorstring nullable

This cursor allows forward pagination, by providing the cursor from the previous request.

limit_per_pageinteger nullable

The page size requested.

resource_addressstring required

Bech32m-encoded human readable version of the address.

non_fungible_idstring

String-encoded non-fungible ID.

Example request

{
  "limit_per_page": 100,
  "resource_address": "<sample-requirement-resource-address>",
  "non_fungible_id": "<sample-requirement-non-fungible-id>"
}

Response

List of entities that have ever used the queried requirement in their access rules.

total_countinteger nullable

Total number of items in underlying collection, fragment of which is available in items collection.

next_cursorstring nullable

If specified, contains a cursor to query next page of the items collection.