> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gc.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List Playbooks

> List playbooks accessible to the caller.

With a user-scoped key, returns playbooks the user created, org-visible playbooks, shared playbooks, and official playbooks. With an org-scoped key, returns org-visible and official playbooks.



## OpenAPI

````yaml GET /playbooks
openapi: 3.0.3
info:
  title: GC AI External API
  version: 1.0.0
  description: >-
    The GC AI External API allows programmatic access to GC AI's chat
    capabilities. It's designed for integration with workflow automation tools
    like Zapier, Make, n8n, or custom applications.


    ## Authentication


    All API requests must include an API key in the `Authorization` header:


    ```

    Authorization: gcai_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

    ```


    API keys can be created in the GC AI app under **Settings → API**.


    ## Current Limitations


    The API is optimized for single-turn completions. The following are not yet
    available via API:


    - **Multi-turn conversations**: each request is independent

    - **Interactive clarification**: the model cannot pause to ask the caller a
    follow-up question; the `askUserQuestions` tool is disabled on the API
    surface in beta


    ## Usage


    Usage is tracked and viewable in the GC AI app under **Settings → API → View
    Usage**.


    ## Support


    For API support, contact [support@gc.ai](mailto:support@gc.ai) or reach out
    to your account representative.
  contact:
    email: support@gc.ai
servers:
  - url: https://app.gc.ai/api/external/v1
    description: Production server
security: []
tags:
  - name: Chat
    description: AI chat completion endpoints
  - name: Files
    description: File upload and management endpoints
  - name: Folders
    description: Folder management endpoints
  - name: Playbooks
    description: Playbook review endpoints
  - name: Projects
    description: Project management endpoints
  - name: Utility
    description: Health check and connectivity endpoints
paths:
  /playbooks:
    get:
      tags:
        - Playbooks
      summary: List playbooks
      description: >-
        List playbooks accessible to the caller.


        With a user-scoped key, returns playbooks the user created, org-visible
        playbooks, shared playbooks, and official playbooks. With an org-scoped
        key, returns org-visible and official playbooks.
      operationId: listPlaybooks
      parameters:
        - schema:
            type: integer
            minimum: 1
            maximum: 500
            default: 100
            description: Max items to return (default 100, max 500)
          required: false
          description: Max items to return (default 100, max 500)
          name: limit
          in: query
        - schema:
            type: integer
            nullable: true
            minimum: 0
            default: 0
            description: Number of items to skip (default 0)
          required: false
          description: Number of items to skip (default 0)
          name: offset
          in: query
      responses:
        '200':
          description: List of playbooks
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlaybookListResponse'
        '401':
          description: Missing or malformed API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Service temporarily unavailable
          headers:
            Retry-After:
              schema:
                type: string
                description: >-
                  Seconds to wait before retrying after a transient service
                  outage.
                example: '5'
              required: true
              description: >-
                Seconds to wait before retrying after a transient service
                outage.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    PlaybookListResponse:
      type: object
      properties:
        playbooks:
          type: array
          items:
            $ref: '#/components/schemas/PlaybookResponse'
        pagination:
          $ref: '#/components/schemas/Pagination'
      required:
        - playbooks
        - pagination
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error message
        message:
          type: string
          description: Additional error details
        details:
          type: object
          additionalProperties:
            nullable: true
          description: Validation error details (for 400 errors)
      required:
        - error
    PlaybookResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique playbook identifier
        title:
          type: string
          description: Playbook title
        description:
          type: string
          nullable: true
          description: Playbook description, or null if unset
        is_official:
          type: boolean
          description: Whether this is an official GC AI playbook
        status:
          type: string
          enum:
            - draft
            - processing
            - completed
            - failed
          description: Playbook processing status
        created_at:
          type: string
          nullable: true
          description: ISO 8601 creation timestamp
      required:
        - id
        - title
        - description
        - is_official
        - status
        - created_at
    Pagination:
      type: object
      properties:
        limit:
          type: number
          description: Page size
        offset:
          type: number
          description: Current offset
        has_more:
          type: boolean
          description: Whether more results exist
      required:
        - limit
        - offset
        - has_more
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: |-
        API key for authentication. Format: `gcai_xxxxxxxxx`

        Create API keys in the GC AI app under Settings → API.

````