---
title: "List all pipelines"
---

> Documentation Index
> Fetch the complete documentation index at: https://www.arroyo.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List all pipelines

Path: Arroyo REST API › pipelines

`GET /v1/pipelines`

URL: `http://localhost:5115/api/v1/pipelines`

## Query parameters

- `starting_after` (`get_pipelines.query.starting_after`; string, optional)
- `limit` (`get_pipelines.query.limit`; integer, optional)
  - format: `int32` · minimum: `0`

## Code samples

### cURL

```bash
curl --request GET \
  --url http://localhost:5115/api/v1/pipelines
```

### TypeScript

```typescript
const url = 'http://localhost:5115/api/v1/pipelines';
const options = {method: 'GET'};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "http://localhost:5115/api/v1/pipelines"

response = requests.get(url)

print(response.text)
```

## Responses

### 200

Got pipelines collection

#### Example

```json
{
  "data": [
    {
      "action": "none",
      "action_in_progress": true,
      "action_text": "string",
      "checkpoint_interval_micros": 0,
      "created_at": 0,
      "graph": {
        "edges": [
          {
            "dest_id": 0,
            "edge_type": "string",
            "key_type": "string",
            "src_id": 0,
            "value_type": "string"
          }
        ],
        "nodes": [
          {
            "description": "string",
            "node_id": 0,
            "operator": "string",
            "parallelism": 0
          }
        ]
      },
      "id": "string",
      "name": "string",
      "preview": true,
      "query": "string",
      "state_url": "string",
      "stop": "none",
      "tags": {
        "property1": "string",
        "property2": "string"
      },
      "udfs": [
        {
          "definition": "string",
          "language": "python"
        }
      ]
    }
  ],
  "hasMore": true
}
```

- `data` (`get_pipelines.response.200.data`; array of object, required)
  - `action_in_progress` (`get_pipelines.response.200.data.action_in_progress`; boolean, required)
  - `action_text` (`get_pipelines.response.200.data.action_text`; string, required)
  - `checkpoint_interval_micros` (`get_pipelines.response.200.data.checkpoint_interval_micros`; integer, required)
    - format: `int64` · minimum: `0`
  - `created_at` (`get_pipelines.response.200.data.created_at`; integer, required)
    - format: `int64` · minimum: `0`
  - `graph` (`get_pipelines.response.200.data.graph`; object, required)
    - `edges` (`get_pipelines.response.200.data.graph.edges`; array of object, required)
      - `dest_id` (`get_pipelines.response.200.data.graph.edges.dest_id`; integer, required)
        - format: `int32` · minimum: `0`
      - `edge_type` (`get_pipelines.response.200.data.graph.edges.edge_type`; string, required)
      - `key_type` (`get_pipelines.response.200.data.graph.edges.key_type`; string, required)
      - `src_id` (`get_pipelines.response.200.data.graph.edges.src_id`; integer, required)
        - format: `int32` · minimum: `0`
      - `value_type` (`get_pipelines.response.200.data.graph.edges.value_type`; string, required)
    - `nodes` (`get_pipelines.response.200.data.graph.nodes`; array of object, required)
      - `description` (`get_pipelines.response.200.data.graph.nodes.description`; string, required)
      - `node_id` (`get_pipelines.response.200.data.graph.nodes.node_id`; integer, required)
        - format: `int32` · minimum: `0`
      - `operator` (`get_pipelines.response.200.data.graph.nodes.operator`; string, required)
      - `parallelism` (`get_pipelines.response.200.data.graph.nodes.parallelism`; integer, required)
        - format: `int32` · minimum: `0`
  - `id` (`get_pipelines.response.200.data.id`; string, required)
  - `name` (`get_pipelines.response.200.data.name`; string, required)
  - `preview` (`get_pipelines.response.200.data.preview`; boolean, required)
  - `query` (`get_pipelines.response.200.data.query`; string, required)
  - `stop` (`get_pipelines.response.200.data.stop`; string, required)
    - one of `"none"`, `"checkpoint"`, `"graceful"`, `"immediate"`, `"force"`
  - `tags` (`get_pipelines.response.200.data.tags`; map of string, required) — User-defined key/value tags associated with the pipeline.
  - `udfs` (`get_pipelines.response.200.data.udfs`; array of object, required)
    - `definition` (`get_pipelines.response.200.data.udfs.definition`; string, required)
    - `language` (`get_pipelines.response.200.data.udfs.language`; string, optional)
      - one of `"python"`, `"rust"`
  - `action` (`get_pipelines.response.200.data.action`; string, optional, nullable)
    - one of `"none"`, `"checkpoint"`, `"graceful"`, `"immediate"`, `"force"`
  - `state_url` (`get_pipelines.response.200.data.state_url`; string, optional, nullable) — Optional URL pointing to the state the pipeline was started from.
- `hasMore` (`get_pipelines.response.200.hasMore`; boolean, required)


Source: https://www.arroyo.dev/docs/api/get-pipelines/index.md
