Plug Database icon

Plug Database

Run Plug Database commands over REST or Socket.

Client Access → List Client Agents

AI-generated

Summary

Lists Plug client agents, optionally filtering by status or search text, refreshing online status, and retrieving additional pages. Returns the agents as n8n items, with optional Plug operation and pagination metadata.

Inputs

  • status — Filter agents by All (default), Active, or Inactive.
  • search — Optional search text forwarded to Plug.
  • returnAll — When enabled, requests all pages before returning results. Defaults to false.
  • page — Page to request when Return All is disabled; defaults to 1.
  • pageSize — Number of agents per page when Return All is disabled; defaults to 50.
  • refresh — When enabled, asks Plug to refresh online agents on the requested page from the live socket profile. Defaults to false.
  • includePlugMetadata — Defaults to true; controls whether each output item includes a __plug object with operation and pagination metadata.

Output shape

A list of n8n items, one per agent.

Each item contains an agent record. The __plug metadata object is included by default and can be disabled.

Links

Discussion