Plug Database Advanced icon

Plug Database Advanced

Run Plug Database commands over REST or Socket.

Actions26

Client Access → List Client Agents

AI-generated

Summary

List client agents with optional filtering by agent status, pagination controls, search text, and live state refresh; return metadata optionally.

Inputs

  • Include Plug Metadata — Whether to include the __plug object with operation and pagination metadata in the response.
  • Agent Status — Filter agents by status: All, Active, or Inactive.
  • Search — Optional search text forwarded to Plug to filter agents.
  • Return All — Whether to retrieve all pages of agents automatically before returning.
  • Page — Page number to request from Plug when Return All is false.
  • Page Size — Number of agents per page to request from Plug when Return All is false.
  • Refresh Live Agent State — Whether to refresh the online status of agents in the current page from live socket profiles before responding.

Output shape

a list of client agent items

Returns an array of client agent objects optionally with __plug metadata on the last item if included. Pagination applies based on page and page size unless Return All is true, in which case all pages are aggregated.

Links

Discussion