> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.runtype.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.runtype.com/_mcp/server.

# List flows

GET https://api.runtype.com/v1/flows

Get all flows for the authenticated user with filtering and cursor pagination.

Reference: https://docs.runtype.com/api-reference/runtype-api/flows/list-flows

## Authentication

- `Authorization` header (bearer token, required) — API key or Clerk session token

## Servers

- `https://api.runtype.com` (Production, default)
- `https://api.runtype-staging.com` (Staging)

## Request

### Query parameters

- `limit` (string, optional)
- `cursor` (string, optional)
- `direction` (string, optional)
- `includeCount` (string, optional)
- `search` (string, optional)
- `view` (enum, optional) — Response representation. `full` (default) preserves complete values; `compact` shortens every string value longer than 100 characters to a 100-character preview followed by `…`.
  - Allowed values: `full`, `compact`
- `include` (enum, optional) — usage adds each flow usage: the model ids its steps name and the record types its steps write.
  - Allowed values: `usage`

## Response

### 200

Paginated list of flows

- `data` (list of V1FlowsGetResponsesContentApplicationJsonSchemaDataItems, required)
- `pagination` (Pagination, required)

## Errors

### 400 Bad Request Error

Invalid parameters

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 401 Unauthorized Error

Unauthorized

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 403 Forbidden Error

Insufficient permissions

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 500 Internal Server Error

Internal server error

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

## Types

### V1FlowsGetResponsesContentApplicationJsonSchemaDataItems

- `createdAt` (string, required)
- `draftVersionId` (string, required, nullable)
- `id` (string, required)
- `lastModifiedSource` (string, required, nullable)
- `lastRunAt` (string, required, nullable)
- `name` (string, required)
- `publishedVersionId` (string, required, nullable) — The live version id, or null while the flow has never been published.
- `updatedAt` (string, required)
- `usage` (V1FlowsGetResponsesContentApplicationJsonSchemaDataItemsUsage, optional) — What the saved flow steps reach. Present only when the request asked for include=usage.

### Pagination

- `currentOffset` (integer, required)
- `hasMore` (boolean, required)
- `hasPrev` (boolean, required)
- `limit` (integer, required)
- `nextCursor` (string, required, nullable)
- `prevCursor` (string, required, nullable)
- `currentPage` (integer, optional)
- `totalCount` (integer, optional)
- `totalPages` (integer, optional)

### ErrorDetailsItems

- `message` (string, required)
- `code` (string, optional) — Stable Runtype validation code (e.g. MISSING_REQUIRED_FIELD, INVALID_ENUM).
- `path` (string, optional) — Dotted JSON path to the offending field.
- `suggestion` (string, optional) — Actionable hint (allowed values, accepted range, …).

### V1FlowsGetResponsesContentApplicationJsonSchemaDataItemsUsage

What the saved flow steps reach. Present only when the request asked for include=usage.

- `models` (list of string, required) — Model ids the flow steps name, each once.
- `recordTypesWritten` (list of string, required) — Record types the upsert-record and update-record steps write, each once.

## Examples

**Response**

```json
{
  "data": [
    {
      "createdAt": "string",
      "draftVersionId": "string",
      "id": "string",
      "lastModifiedSource": "string",
      "lastRunAt": "string",
      "name": "string",
      "publishedVersionId": "string",
      "updatedAt": "string",
      "usage": {
        "models": [
          "string"
        ],
        "recordTypesWritten": [
          "string"
        ]
      }
    }
  ],
  "pagination": {
    "currentOffset": 1,
    "hasMore": true,
    "hasPrev": true,
    "limit": 1,
    "nextCursor": "string",
    "prevCursor": "string",
    "currentPage": 1,
    "totalCount": 1,
    "totalPages": 1
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.runtype.com/v1/flows"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.runtype.com/v1/flows';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.runtype.com/v1/flows"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.runtype.com/v1/flows")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.runtype.com/v1/flows")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.runtype.com/v1/flows', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.runtype.com/v1/flows");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.runtype.com/v1/flows")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```