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

# Get a page of workflow documents

GET http://localhost:3000/automation-studio/workflows

Returns a page of workflow documents.

Reference: https://docs.itential.com/itential-platform/6/api-reference/automation-studio/get-workflows

## Authentication

- `Authorization` header (basic auth, required) — Basic authentication of the form `Basic <base64(username:password)>`.

## Request

### Query parameters

- `limit` (integer, optional, default: 25) — Number of results to return. Used for pagination.
- `skip` (integer, optional, default: 0) — Number of results to skip. Used for pagination.
- `order` (enum, optional, default: 1) — Sort direction, 1 for ascending and -1 for descending.
  - Allowed values: `-1`, `1`
- `sort` (enum, optional, default: name) — Field to sort by
  - Allowed values: `name`
- `exclude-project-members` (boolean, optional) — Flag which removes workflows from the results which are members of a project
- `include` (string, optional) — Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.
- `exclude` (string, optional) — Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.
- `expand` (string, optional) — Sets the fields to expand. Generally, these are fields like "metrics.user", "metrics.owner", "created_by", etc
- `in` (string, optional) — Search for fields exactly matching one of the given list options
- `not-in` (string, optional) — Search for fields not exactly matching one of the given list options
- `equals` (string, optional) — Returns results where the specified fields exactly match the given match string(s).
- `contains` (string, optional) — Returns results where the specified fields contain the given match string(s).
- `starts-with` (string, optional) — Returns results where the specified fields start with the given match string(s).
- `ends-with` (string, optional) — Returns results where the specified fields end in the given match string(s).
- `task-equals` (string, optional) — Returns results where one or more tasks have fields that exactly match the given match string(s).

## Response

### 200

Results for the given search parameters.

- `items` (list of object, optional)
  - `name` (string, required)
  - `type` (string, required, default: automation)
  - `tasks` (object, required)
    - `workflow_start` (object, required)
      - `name` (string, optional)
      - `summary` (string, optional)
      - `groups` (list of string, optional)
      - `nodeLocation` (object, optional) — Stores the coordinates used by canvasVersion: 3 workflows
        - `x` (double, optional)
        - `y` (double, optional)
    - `workflow_end` (object, required)
      - `name` (string, optional)
      - `summary` (string, optional)
      - `groups` (list of string, optional)
      - `nodeLocation` (object, optional) — Stores the coordinates used by canvasVersion: 3 workflows
        - `x` (double, optional)
        - `y` (double, optional)
    - `error_handler` (object, optional) — Deprecated gen2-specific feature
      - `name` ("childJob", required)
      - `summary` (string, required)
      - `description` (string, required)
      - `app` (string, required)
      - `variables` (object, required)
        - `incoming` (object, required)
        - `outgoing` (object, required)
        - `error` (string, optional)
        - `decorators` (list of object, optional)
          - `type` (enum, optional)
            - Allowed values: `encryption`
          - `pointer` (string, optional)
      - `groups` (list of string, required)
      - `type` ("operation", required)
      - `nodeLocation` (object, optional) — Stores the coordinates used by canvasVersion: 3 workflows
        - `x` (double, optional)
        - `y` (double, optional)
      - `deprecated` (boolean, optional)
      - `scheduled` (boolean, optional)
      - `retrySettings` (object, optional, nullable) — Retry settings for a task.
        - `state` (list of enum, required) — Finish states the task will retry on. The task will retry on any of the included states.
          - Allowed values: `success`, `error`, `failure`
        - `autoRetry` (boolean, required) — Whether the task is set to retry automatically or manually.
        - `limit` (integer, required) — Limit of retries on a task before it will take normal transitions and stop retrying.
        - `delay` (integer, required) — Delay between each retry in milliseconds.
        - `count` (integer, optional) — Current retry count used for workflow engine job processing
  - `transitions` (object, required)
    - `workflow_start` (object, required)
    - `workflow_end` (object, required)
    - `error_handler` (object, optional)
  - `groups` (list of string, required)
  - `canvasVersion` (double, required)
  - `_id` (string, optional)
  - `uuid` (string, optional)
  - `namespace` (object, optional)
    - `type` (any, required)
    - `_id` (object, required) — A MongoDB ObjectId
    - `name` (string, required)
    - `accessControl` (object, required)
      - `read` (list of string, required)
      - `execute` (list of string, required)
      - `write` (list of string, required)
      - `manage` (list of string, required)
  - `description` (string, optional, nullable)
  - `preAutomationTime` (integer, optional) — Time (milliseconds) automation would have taken someone to complete without using IAP.
  - `sla` (integer, optional)
  - `errorHandler` (object, optional, nullable) — Deprecated gen2-specific feature
    - `type` (string, optional)
    - `name` (string, optional)
  - `font_size` (integer, optional, default: 12) — Deprecated, unused, gen1-specific feature
  - `created` (string, optional)
  - `created_by` (any, optional)
  - `createdVersion` (string, optional)
  - `last_updated` (string, optional)
  - `last_updated_by` (any, optional)
  - `lastUpdatedVersion` (string, optional) — This value represents the semantic version of the application that last modified it. For workflows with canvasVersion = 1, this field will refer to the version of Workflow Builder. For workflows with canvasVersion > 1, this field will refer to the version of Studio.
  - `tags` (list of string, optional)
  - `encodingVersion` (enum, optional)
    - Allowed values: `1`
  - `inputSchema` (object, optional)
  - `outputSchema` (object, optional)
  - `outputData` (map from string to object, optional) — Deprecated gen2-specific feature
    - `taskId` (string, optional)
    - `taskPointer` (string, optional)
  - `decorators` (list of object, optional)
    - `type` (enum, optional)
      - Allowed values: `encryption`
    - `pointer` (string, optional)
  - `migrationVersion` (integer, optional)
- `total` (integer, optional) — Total number of documents matching the given query parameters.
- `start` (integer, optional) — Search index of first document in the items array.
- `end` (integer, optional) — Search index of the last document in the items array.
- `count` (integer, optional) — Length of the items array.
- `limit` (integer, optional) — Number of results to return. Used for pagination.
- `next` (string, optional, nullable) — URI pointing to the next set of paginated results. Preserves previous search and projection parameters. Null if returning the last page of results.
- `previous` (string, optional, nullable) — URI pointing to the previous set of paginated results. Preserves previous search and projection parameters. Null if returning the first page of results.

## Errors

### 500 Internal Server Error

Error response from API

- `any`

## Examples

**Response**

```json
{
  "items": [
    {
      "name": "Port Turn Up IOS",
      "type": "automation",
      "tasks": {
        "workflow_start": {
          "name": "string",
          "summary": "string",
          "groups": [
            "string"
          ],
          "nodeLocation": {
            "x": 1.1,
            "y": 1.1
          }
        },
        "workflow_end": {
          "name": "string",
          "summary": "string",
          "groups": [
            "string"
          ],
          "nodeLocation": {
            "x": 1.1,
            "y": 1.1
          }
        },
        "error_handler": {
          "name": "string",
          "summary": "string",
          "description": "string",
          "app": "string",
          "variables": {
            "incoming": {},
            "outgoing": {},
            "error": "string",
            "decorators": [
              {
                "type": "encryption",
                "pointer": "string"
              }
            ]
          },
          "groups": [
            "string"
          ],
          "type": "string",
          "nodeLocation": {
            "x": 1.1,
            "y": 1.1
          },
          "deprecated": true,
          "scheduled": true,
          "retrySettings": {
            "state": [
              "success"
            ],
            "autoRetry": true,
            "limit": 10,
            "delay": 1000,
            "count": 5
          }
        }
      },
      "transitions": {
        "workflow_start": {},
        "workflow_end": {},
        "error_handler": {}
      },
      "groups": [
        "string"
      ],
      "canvasVersion": 1.1,
      "_id": "string",
      "uuid": "string",
      "namespace": {
        "type": null,
        "_id": {},
        "name": "string",
        "accessControl": {
          "read": [
            "string"
          ],
          "execute": [
            "string"
          ],
          "write": [
            "string"
          ],
          "manage": [
            "string"
          ]
        }
      },
      "description": "Port Turn Up IOS",
      "preAutomationTime": 5000,
      "sla": 1,
      "errorHandler": null,
      "font_size": 12,
      "created": "2024-03-13T18:21:15.352Z",
      "createdVersion": "5.40.5-2021.1.72.0",
      "last_updated": "2024-03-13T18:21:15.352Z",
      "lastUpdatedVersion": "4.69.69",
      "tags": [
        "string"
      ],
      "encodingVersion": 1,
      "inputSchema": {},
      "outputSchema": {},
      "outputData": {},
      "decorators": [
        {
          "type": "encryption",
          "pointer": "string"
        }
      ],
      "migrationVersion": 1
    }
  ],
  "total": 1,
  "start": 1,
  "end": 1,
  "count": 1,
  "limit": 1,
  "next": "string",
  "previous": "string"
}
```

**SDK Code**

```python
import requests

url = "http://localhost:3000/automation-studio/workflows"

response = requests.get(url)

print(response.json())
```

```javascript
const url = 'http://localhost:3000/automation-studio/workflows';
const options = {method: 'GET'};

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 := "http://localhost:3000/automation-studio/workflows"

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

	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("http://localhost:3000/automation-studio/workflows")

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

request = Net::HTTP::Get.new(url)

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("http://localhost:3000/automation-studio/workflows")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'http://localhost:3000/automation-studio/workflows');

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

```csharp
using RestSharp;

var client = new RestClient("http://localhost:3000/automation-studio/workflows");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "http://localhost:3000/automation-studio/workflows")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

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()
```