Plug Database icon

Plug Database

Run Plug Database commands over REST or Socket.

User Access → List Agent Clients

AI-generated

Summary

Retrieve a list of clients associated with a specific Plug agent by providing the agent's unique identifier. Optionally include metadata object with operation and pagination details in the output.

Inputs

  • Agent ID (required) — The unique identifier string of the Plug agent whose clients are to be listed.
  • Include Plug Metadata — Boolean flag to include the __plug metadata object with operation and pagination details in the response; defaults to true.

Output shape

a list of client records associated with the specified agent, optionally augmented with a __plug metadata object containing operation and pagination metadata.

The returned data optionally includes the __plug object depending on the 'Include Plug Metadata' input. The operation requires a valid 'Agent ID' and outputs structured client data suitable for use in subsequent workflow steps.

Links

Discussion