Search Request

Use the following parameters to search requests.

Security(Ledger_API_Key and Ledger_API_User) or Ledger_API_Key and Ledger_API_User and Ledger_Store_Auth_Token) or Ledger_API_User or Ledger_API_User and Ledger_Store_Auth_Token)
Request
query Parameters
approved_by
integer or null
Default: null

Returns requests which have been approved by the specified user.

Example: approved_by=42
created_after
string or null <date-time>
Default: null

Returns objects created after the entered date.

Example: created_after=2020-09-12T14:15:22Z
created_before
string or null <date-time>
Default: null

Returns objects created before the entered date.

Example: created_before=2020-12-13T16:17:28Z
created_by
integer or null
Default: null

Returns requests which have been created by the specified user.

Example: created_by=42
id
integer or null
Default: null

Returns the object corresponding to the entered ID

order
string or null
Default: null

Orders the list of results

Enum: "asc" "desc"
Example: order=desc
order_by
string or null
Default: null

criteria to order by

Example: order_by=name
page
integer or null >= 1
Default: 1

Defines the page number to be fetched.

Example: page=3
page_size
integer or null >= -1
Default: 20

Defines the number of elements displayed on a page. Must be a positive number with 0 and -1 being special values to return a maximum defined in the gate

Example: page_size=40
pending_by
integer or null
Default: null

Returns requests which are pending the specified user's approval.

Example: pending_by=42
rejected_by
integer or null
Default: null

Returns requests which have been rejected by the specified user.

Example: rejected_by=42
status
Array of strings or null
Default: null

Returns objects that match the selected status.

Enum: "ACTIVE" "APPROVED" "BLOCKED" "EXPIRED" "PENDING_APPROVAL" "PENDING_FIRST_APPROVAL" "PENDING_REGISTRATION" "REJECTED" "SIGNED" "SUBMITTED"
target_id
integer or null
Default: null

Search by ID of the target object.

target_type
Array of strings or null
Default: null

Search requests by object type.

Enum: "ACCOUNT" "ENTITY" "GROUP" "TRANSACTION" "USER" "WHITELIST"
type
Array of strings or null
Default: null

Search requests by request type.

Enum: "CREATE_ACCOUNT" "CREATE_ADMIN" "CREATE_API_USER" "CREATE_API_USER_ACCESS" "CREATE_DAPPS_CONFIG" "CREATE_ENTITY" "CREATE_GROUP" "CREATE_OPERATOR" "CREATE_TRANSACTION" "CREATE_WHITELIST" "EDIT_ACCOUNT" "EDIT_DAPPS_CONFIG" "EDIT_ENTITY" "EDIT_GROUP" "EDIT_WHITELIST" "MIGRATE_ACCOUNT" "MIGRATE_ADMIN" "MIGRATE_GROUP" "MIGRATE_OPERATOR" "MIGRATE_WHITELIST" "REVOKE_ENTITY" "REVOKE_GROUP" "REVOKE_USER" "UPDATE_QUORUM"
Responses
200

Request search results

400

Invalid search parameters

get/requests
Response samples
application/json
{
  • "edges": [
    ],
  • "page_info": {
    }
}
Copyright © Ledger Enterprise Platform 2023. All right reserved.