Building a webhook integration? Read the webhook guide for signatures, retries, event schemas, and troubleshooting.

apiDeterministic

List agent work orders

GET /api/agents/work-orders/external

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

REST requestbash

curl -X GET "https://app.pipeline.help/api/agents/work-orders/external" \
  -H "Authorization: Bearer $PIPELINE_API_KEY"

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"
  ]
}

HTTP errors

401: Missing or invalid API key.
403: Authenticated but not permitted for the workspace or resource.
404: The requested resource was not found.