Plug Database Advanced icon

Plug Database Advanced

Run Plug Database commands over REST or Socket.

Client Access → List Access Requests

AI-generated

Summary

Retrieve a list of client access requests filtered by status and search criteria, with configurable pagination and optional inclusion of metadata about the operation and pagination.

Inputs

  • Include Plug Metadata — Option to include the __plug object containing operation and pagination metadata in the response (default true).
  • Request Status — Filter access requests by their status: all, pending, approved, rejected, expired, or revoked (default all).
  • Search — Optional text search criteria forwarded to the Plug backend to filter access requests. Defaults to an empty string for no filtering.
  • Return All — If true, retrieve all pages of access requests before returning results. If false, return a single page.
  • Page — Page number to request from the Plug backend when Return All is false (default 1).
  • Page Size — Number of access request items per page when Return All is false (default 50).

Output shape

a list of access request items optionally wrapped with metadata.

Results can be paginated: if Return All is false, results correspond to the specified page and page size; if Return All is true, all pages are aggregated. The __plug metadata object includes information such as total count, current page, and other pagination details when included.

Examples

Example 1: Retrieve all approved client access requests matching 'example' in their details including metadata

Set Request Status to 'Approved', Search to 'example', Return All to true, and Include Plug Metadata to true.

Links

Discussion