policy
List policies
get/policies
Request
- The document declares no server URL.
- Auth
- API key in header X-Ledger-API-User
- or API key in header X-Ledger-API-User and API key in header X-Ledger-API-Key
- or API key in header X-Ledger-API-User and Ledger_Store_Auth_Token (a scheme the document does not define)
- or API key in header X-Ledger-API-User and API key in header X-Ledger-API-Key and Ledger_Store_Auth_Token (a scheme the document does not define)
Query parameters
pageinteger
Which page to fetch
pageSizeinteger
Page size to use
namestring
Search by matching name
isPrivateboolean
Search private policies
currencystring
Search by currency
contractAddressstring
Filter by token contract address (requires 'currency')
tokenIdentifierstring
Filter by token identifier (requires 'currency')
policyType'single' | 'multiple'
Filter by policy type: 'single' returns policies with any currency assigned, 'multiple' returns policies without a currency (multicurrency)
sortBy'name' | 'createdAt' | 'updatedAt'
Sort by attribute
sortOrder'asc' | 'desc'
Sort order
Response
Successful response
Changes
No recorded changes to this operation across all 1 revision of this API.