---
title: "Get a playbook by ID"
method: GET
path: "/playbooks/{playbook_id}"
tags: ["Playbooks"]
---

# Get a playbook by ID

`GET /playbooks/{playbook_id}`

## Request

- Base URL: `https://api.oneflow.com/v1`
- URL: `https://api.oneflow.com/v1/playbooks/{playbook_id}`
- Auth: none declared. Required headers: `x-oneflow-api-token`

Use this endpoint to retrieve a specific playbook by its ID.

## Path parameters

- `playbook_id` integer, required

## Headers

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

## Response `200`

Returns the specified playbook, including its data fields.

- object: Playbook attributes
  - `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
  - `data_fields` object[], required
    - `description` string, required: The data field description from the playbook.
    - `id` integer, required: The data field ID from the playbook.
    - `name` string, required: The data field name from the playbook.
    - `default_value` string, nullable, required: The data field default value from the playbook.
    - `data_type` string, required: The data field type from the playbook.
    - `custom_id` string, nullable, required: The custom ID from the connected integration blueprint associated with the token used in the request.
  - `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.
- `404`: A required entity is missing.

## Changes

- **2026-11-03** `0a4e1e88ac45`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/oneflow/apis/public-api-for-oneflow/changes/playbooks/:playbook_id/get.md)

---

[API](https://skmtc.dev/oneflow/apis/public-api-for-oneflow.md) - [All operations](https://skmtc.dev/oneflow/apis/public-api-for-oneflow/llms.txt) - [OpenAPI document](https://skmtc.dev/oneflow/apis/public-api-for-oneflow/revisions/0a4e1e88ac45?raw)