---
title: "Get playbooks"
method: GET
path: "/playbooks"
tags: ["Playbooks"]
---

# Get playbooks

`GET /playbooks`

Use this endpoint to get a list of playbooks.

## Query parameters

- `offset` integer
- `limit` integer
- `sort` string
- `filter[enabled]` 'true' | 'false'
- `filter[integration_blueprint_id]` string

## Headers

- `x-oneflow-api-token` string, required
- `x-oneflow-user-email` string, email

## Response `200`

Returns a list of playbooks.

- object — A list of playbooks in an account.
  - `_links` object — Links to related endpoints.
    - `comments` object
      - `href` string, nullable
    - `contracts` object
      - `href` string, nullable
    - `contract` object
      - `href` string, nullable
    - `create` object
      - `href` string, nullable
    - `data_field` object
      - `href` string, nullable
    - `data_fields` object
      - `href` string, nullable
    - `events` object
      - `href` string, nullable
    - `event` object
      - `href` string, nullable
    - `files` object
      - `href` string, nullable
    - `file` object
      - `href` string, nullable
    - `next` object
      - `href` string, nullable
    - `parties` object
      - `href` string, nullable
    - `party` object
      - `href` string, nullable
    - `previous` object
      - `href` string, nullable
    - `publish` object
      - `href` string, nullable
    - `self` object
      - `href` string, nullable
    - `template_types` object
      - `href` string, nullable
    - `template_type` object
      - `href` string, nullable
    - `template` object
      - `href` string, nullable
    - `templates` object
      - `href` string, nullable
    - `workspaces` object
      - `href` string, nullable
    - `workspace` object
      - `href` string, nullable
    - `playbooks` object
      - `href` string, nullable
  - `count` integer, required
  - `data` object[], required
    - `connected_integration_blueprints` object[], required — All integration blueprints associated with the playbook.
      - `id` integer, required
      - `name` string, required
    - `created_time` string, datetime, nullable
    - `description` string, nullable
    - `enabled` boolean, required
    - `id` integer, required
    - `name` string, required
    - `updated_time` string, datetime, nullable

## Other responses

- `400` — Invalid format or content of the request.
- `401` — The API token or the user email is invalid.

---

[API](https://skmtc.net/oneflow/apis/public-api-for-oneflow.md) · [All operations](https://skmtc.net/oneflow/apis/public-api-for-oneflow/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/oneflow/public-api-for-oneflow/versions/0e73a45dec15/schema)