Skip to main content
GET
/
playbooks
/
{slug}
Get playbook
curl --request GET \
  --url https://api.pickfu.com/v1/playbooks/{slug} \
  --header 'Authorization: Bearer <token>'
{
  "slug": "<string>",
  "name": "<string>",
  "description": "<string>",
  "industry": "<string>",
  "poll_count": 123,
  "duration": "<string>",
  "icon": "<string>",
  "goal": "<string>",
  "steps_markdown": "<string>",
  "project_name_template": "<string>",
  "url": "<string>"
}

Authorizations

​
Authorization
string
header
required

OAuth2 access token obtained via the authorization flow. Include in the Authorization header as: Bearer {access_token}

Path Parameters

​
slug
string
required

Playbook slug (GUID)

Response

Default Response

​
slug
string | null

Unique playbook identifier (GUID)

​
name
string

Playbook name

​
description
string | null

Short description of the playbook

​
industry
string | null

Industry category

​
poll_count
integer

Number of polls in this playbook

​
duration
string | null

Estimated completion time (e.g. "2-3 days")

​
icon
string | null

Icon identifier or emoji

​
goal
string | null

The research goal this playbook helps achieve

​
steps_markdown
string | null

Formatted instructions with embedded poll creation links

​
project_name_template
string | null

Template for the project name when starting this playbook

​
url
string | null

Direct URL to view this playbook on PickFu