Ledger Enterprise
API Documentation V1
API Documentation V1
  • GETTING STARTED
    • Welcome
    • Getting Started
    • Authentication
    • Rate Limits
    • Pagination
  • tutorials
    • Register a new API User
    • First Steps as an API User
    • Generate Reporting API Keys
    • Manage Reporting API Keys
  • REFERENCE
    • API reference
      • Accounts
        • Search Accounts
        • Get an Account by ID
        • Addresses
          • [Decprecated] Get Receiving Addresses of an Account
          • Get Receiving Addresses of an Account
          • [Decprecated] Get an address by index for an account
        • Balances
        • Currency
        • History
        • Labels
        • NFT Collections
        • NFT Portfolio
        • NFTs
        • Sync
        • Tokens
        • ERC20 Child Accounts
      • API users
        • Get List of API Users
        • Create an API User
        • Get an API User
        • Register
      • Currencies and Tokens
        • List Currencies
        • List Tokens
        • Get Currency by Name
        • Get a Token by Network and Address
        • Currency Name and Address Pair
      • Digests
        • Search Digests
        • Get Digests by ID
        • Digest History
      • Entities
        • Search Entity
        • Get an Entity by ID
        • Entity History
        • Get the Users of an Entity
      • Groups
        • Search Group
        • Get Group by ID
        • Group History
      • Labels
      • Messages
        • Search Message
        • Get a Message by ID
        • Message History
      • Organization
      • Pledges
        • Search Pledge
        • Get a Pledge by ID
      • Requests
        • Search Request
        • Create Request
        • Get Request by ID
        • Get Request Challenge (Approve)
        • Get Request Challenge (Reject)
        • Approve Request
        • Reject Request
        • Get the Request's Governance Status
      • Settlements
        • Search Settlements
        • Create Settlement
        • Get a Settlement by ID
      • Transactions
        • Search Transaction
        • Create a Transaction
        • Get a Transaction by ID
        • Estimate Transaction Fees
        • Estimate Transaction Fees
        • Approve Transaction
        • Reject Transaction
        • Transaction History
        • Transaction Labels
      • Users
        • Search Users
        • Search User by ID
        • User History
      • Whitelists
        • Search Whitelist
        • Get Whitelist by ID
        • Whitelist History
      • Auth
        • Get JWT Token
        • Refresh JWT Token
      • Compliance
        • Get an Address' Risk Assessment
        • Get an Address' Sanctions
      • Notifications
        • Get Notification Configuration
        • Set Notification Configuration
    • Specification
Powered by GitBook
On this page
  1. REFERENCE
  2. API reference
  3. Requests

Search Request

PreviousRequestsNextCreate Request

Last updated 1 day ago

List requests

get
Authorizations
Query parameters
pageinteger · min: 1Optional

Which page to fetch

Default: 1
pageSizeinteger · min: 1 · max: 30Optional

Page size to use

Default: 30
typestring · enumOptional

Search by request type

Possible values:
statestring · enumOptional

Search by request state

Possible values:
createdBystringOptional
reviewedBystringOptional
pendingBystringOptional
sortBystring · enumOptional

Sort by attribute

Default: createdAtPossible values:
sortOrderstring · enumOptional

Sort order

Default: ascPossible values:
Responses
200
Successful response
application/json
400
Invalid input data
application/json
401
Authorization not provided
application/json
403
Insufficient access
application/json
404
Not found
application/json
500
Internal server error
application/json
get
GET /rest/requests HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "page": 1,
  "next": 1,
  "prev": 1,
  "pageSize": 1,
  "total": 1,
  "results": [
    {
      "type": "UPDATE_QUORUM",
      "data": {
        "quorum": 1
      },
      "id": "text",
      "legacyId": 1,
      "state": "INITIAL",
      "reviewSteps": [
        {
          "stageName": "text",
          "quorum": 1
        }
      ],
      "currentStepIndex": 1,
      "expiredAt": "text",
      "targetId": "text",
      "note": {
        "title": "text",
        "content": "text"
      },
      "reviews": [
        {
          "stepIndex": 1,
          "userId": "text",
          "status": "PENDING",
          "createdAt": "text",
          "updatedAt": "text"
        }
      ],
      "createdAt": "text",
      "updatedAt": "text"
    }
  ]
}