sdkDeterministic

List agent work orders

pipeline.listAgentWorkOrders

List Agent Teams work orders that an external coding agent can claim. Each item identifies the current stage, internal role, typed task, status, and revision. Launch and sending stages are excluded because Pipeline Campaign Workflows retain ownership. Read-only.

Parameters

workspaceId

string

Optional with an API key, inferred from the key.

limit

number

Maximum claimable work orders to return, 1 to 50. Defaults to 20.

Example

TypeScripttypescript

await pipeline.listAgentWorkOrders({})

Response

Success response schemajson schema

{
  "type": "object",
  "properties": {
    "workOrders": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "objective": {
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "currentStage": {
            "type": [
              "string",
              "null"
            ]
          },
          "role": {
            "type": "string"
          },
          "taskType": {
            "type": "string"
          },
          "revision": {
            "type": "number"
          },
          "updatedAt": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "objective",
          "status",
          "role",
          "taskType",
          "revision",
          "updatedAt"
        ]
      }
    }
  },
  "required": [
    "workOrders"
  ]
}

Exceptions

PipelineError: Thrown for validation, authentication, JSON-RPC, HTTP, and network failures. Inspect code and data when present.