---
title: "Get Playbook Data"
method: GET
path: "/api/version/{versionName}/playbook/{playbookId}/export"
tags: ["Playbook"]
---

# Get Playbook Data

`GET /api/version/{versionName}/playbook/{playbookId}/export`

Retrieves the details of the requested Playbook in a specific version, exporting the Playbook configuration and data in JSON format.

Date-type attributes and playbook questions are returned in the format `yyyy-mm-dd hh:mm:ss`.

The result might differ, depending on the requested features.

## Path parameters

- `versionName` string, required
- `playbookId` string, required

## Response `200`

Success. Returns the Playbook details if a valid identifier is provided.

- PlaybookExportResponse
  - `playbook_metadata` PlaybookMetadata
    - `name` string — Internal playbook name.
    - `display` string — Playbook display name.
    - `document_type` string[] — List of allowed proposal document types.
    - `geo_factors_settings` boolean — Enables geo factor logic.
    - `present_proposal_summary` boolean — Shows the proposal summary.
    - `enable_partner_support` boolean — Indicates whether partner support is enabled.
    - `sync_docs_settings` PlaybookSyncSettings
      - `enabled` string — Sync configuration mode. Valid values: `ALWAYS`, `RULE_BASED`, `DISABLED`.
      - `based_on` string, nullable — Question ID used for the rule. Returns `null` when no rule applies.
    - `sync_products_settings` PlaybookSyncSettings
      - `enabled` string — Sync configuration mode. Valid values: `ALWAYS`, `RULE_BASED`, `DISABLED`.
      - `based_on` string, nullable — Question ID used for the rule. Returns `null` when no rule applies.
  - `playbook_data` PlaybookGroup[] — List of question groups in the Playbook.
    - `group_id` string — Unique group identifier.
    - `group_name` string — Display name of the group.
    - `group_type` 'QUESTIONS_GROUP' | 'REPEATABLE_GROUP' — Group type.
    - `group_external_object` string, nullable — External object reference.
    - `question_data` PlaybookQuestion[] — List of questions in the group.
      - `question_id` string — Unique question ID.
      - `question` string — Question label/text.
      - `question_type` string — Type of question. Valid values: `text`, `text_list`, `numeric`, `date`.
      - `answers` string — Possible answers, separated by a semicolon.
      - `default_answer` string, nullable — Default answer used for API template generation.

---

[API](https://skmtc.net/dealhub/apis/quote-api.md) · [All operations](https://skmtc.net/dealhub/apis/quote-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/dealhub/quote-api/versions/c30f5b9fbfab/schema)