GET /v1/pipelines

Family: Pipelines · Operation ID: v1_list_pipelines

Access

Workspace API key: Authorization: Bearer <key>. The key is scoped to its workspace; the backend checks operation permissions and quota.

Open pipelines

Required scope: pipelines.read

Create a key in Developer settings. Set API_BASE_URL to the current app origin.

Request example

curl --fail-with-body -X GET "$API_BASE_URL/v1/pipelines" \
  -H "Authorization: Bearer $API_KEY"

Parameters

[
  {
    "in": "query",
    "name": "status",
    "required": false,
    "schema": {
      "$ref": "#/components/schemas/PipelineStatus"
    }
  },
  {
    "in": "query",
    "name": "limit",
    "required": false,
    "schema": {
      "format": "int64",
      "type": "integer"
    }
  },
  {
    "in": "query",
    "name": "offset",
    "required": false,
    "schema": {
      "format": "int64",
      "type": "integer"
    }
  }
]

Responses

200

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ListPipelinesResponse"
      }
    }
  },
  "description": "Pipeline list"
}

400

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/PipelineErrorResponse"
      }
    }
  },
  "description": "Bad request"
}

403

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/PipelineErrorResponse"
      }
    }
  },
  "description": "Forbidden"
}

500

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/PipelineErrorResponse"
      }
    }
  },
  "description": "Internal server error"
}

503

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/PipelineErrorResponse"
      }
    }
  },
  "description": "Service unavailable"
}

default

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ErrorEnvelope"
      }
    }
  },
  "description": "Request error"
}

Download the full OpenAPI contract