Skip to main content
GET
/
v2
/
playbooks
/
{id}
Get Playbook
curl --request GET \
  --url https://app.textql.com/v2/playbooks/{id} \
  --header 'Authorization: Bearer <token>'
{
  "playbook": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "prompt": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "connector_ids": [
      123
    ],
    "cron_string": "<string>",
    "email_addresses": [
      "<string>"
    ],
    "slack_channel_id": "<string>"
  },
  "reports": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "subject": "<string>",
      "summary": "<string>",
      "blocks": [
        {
          "heading": "<string>",
          "content": "<string>",
          "image_url": "<string>",
          "image_alt": "<string>",
          "items": [
            "<string>"
          ],
          "blocks": "<array>",
          "height": 123
        }
      ],
      "html_preview": "<string>",
      "chat_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total_reports_count": 123
}

Authorizations

Authorization
string
header
required

API key or JWT token

Path Parameters

id
string<uuid>
required

Playbook ID

Query Parameters

limit
integer<int64>

Maximum number of reports to return

offset
integer<int64>

Number of reports to skip

Response

Playbook details with reports

playbook
object
reports
object[]
total_reports_count
integer<int64>