Skip to navigation
Paperwork APIAgents

List agents

View as Markdown

Lists the agents your organization can run.

An agent is a reviewed, versioned automation: a list of steps, some done by the agent itself and some by a person, plus the saved actions it may take and where a human sign-off is required. Only active agents appear here.

Each entry carries:

FieldWhat it tells you
tasks[]The step ledger — executor: "human" marks the ones a person completes
actions[]What the agent may do, and its approval gate
versionThe revision a new run will snapshot

Start one with POST /v1/agent-runs.

An agent’s id is opaque — treat it as a string and do not parse it.

Learn more: Agents guide

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

The agents.
object"list"
datalist of objects

Errors

401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error