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

# Configurable live-sheet field catalog and saved layout

**Required scope:** `intel.view`

<Note>Requires a plan that includes business intelligence (basic tier). Otherwise the request is refused; see [Errors](/concepts/errors).</Note>


## OpenAPI

````yaml /api-reference/openapi.json get /campaigns/{id}/sheet/configuration
openapi: 3.0.3
info:
  title: Pineyard API
  version: 1.0.0
  description: >-
    Programmatic access to agents, campaigns, calls, phone numbers, WhatsApp and
    results in your Pineyard workspace.
servers:
  - url: https://api.pineyard.ai
    description: Production
security:
  - bearerAuth: []
paths:
  /campaigns/{id}/sheet/configuration:
    get:
      summary: Configurable live-sheet field catalog and saved layout
      parameters:
        - schema:
            type: string
          required: true
          name: id
          in: path
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  legacy:
                    type: boolean
                  source:
                    type: string
                    nullable: true
                    enum:
                      - GENERATED
                      - ATTACHED
                  sheetGid:
                    type: integer
                    nullable: true
                  sheetTitle:
                    type: string
                    nullable: true
                  matchColumn:
                    type: string
                    nullable: true
                  configuration:
                    type: object
                    properties:
                      version:
                        type: number
                        enum:
                          - 1
                      layoutLocked:
                        type: boolean
                        default: true
                      columns:
                        type: array
                        items:
                          type: object
                          properties:
                            key:
                              type: string
                              minLength: 1
                            label:
                              type: string
                              minLength: 1
                              maxLength: 100
                          required:
                            - key
                            - label
                        minItems: 1
                        maxItems: 100
                      filters:
                        type: object
                        properties:
                          interestLevel:
                            type: array
                            items:
                              type: string
                            maxItems: 50
                          qualification:
                            type: array
                            items:
                              type: string
                            maxItems: 50
                          callResult:
                            type: array
                            items:
                              type: string
                            maxItems: 50
                          callbackDue:
                            type: boolean
                          search:
                            type: string
                            maxLength: 200
                          metricFilters:
                            type: array
                            items:
                              type: object
                              properties:
                                key:
                                  type: string
                                values:
                                  type: array
                                  items:
                                    type: string
                                  maxItems: 20
                              required:
                                - key
                                - values
                            maxItems: 20
                          minDurationSec:
                            type: integer
                            minimum: 0
                            maximum: 86400
                          maxDurationSec:
                            type: integer
                            minimum: 0
                            maximum: 86400
                          minAttempts:
                            type: integer
                            minimum: 0
                            maximum: 100
                          calledFrom:
                            type: string
                          calledTo:
                            type: string
                          includeUnscored:
                            type: boolean
                          disposition:
                            type: array
                            items:
                              type: string
                            maxItems: 50
                          tags:
                            type: array
                            items:
                              type: string
                            maxItems: 50
                        default: {}
                      filterViewId:
                        type: integer
                      knownColumnKeys:
                        type: array
                        items:
                          type: string
                        maxItems: 200
                    required:
                      - version
                      - columns
                  catalog:
                    type: array
                    items:
                      type: object
                      properties:
                        key:
                          type: string
                        label:
                          type: string
                        render:
                          type: string
                          enum:
                            - text
                            - phone
                            - recording
                        group:
                          type: string
                          enum:
                            - Identity
                            - Lead details
                            - Evaluation
                            - Call details
                        attachedWritable:
                          type: boolean
                        selected:
                          type: boolean
                        available:
                          type: boolean
                      required:
                        - key
                        - label
                        - render
                        - selected
                        - available
                required:
                  - legacy
                  - source
                  - sheetGid
                  - sheetTitle
                  - matchColumn
                  - configuration
                  - catalog
        '401':
          description: >-
            - `invalid_api_key`: The API key is unknown, revoked or expired, or
            its workspace was deleted.

            - `unauthorized`: No `Authorization: Bearer` header, or an empty
            token.
        '403':
          description: >-
            - `api_key_not_scoped`: A key issued without scopes was used outside
            `/v1`.

            - `api_key_owner_inactive`: The member the key acts for was removed
            or suspended.

            - `feature_not_available`: This feature is not enabled for your
            workspace or plan.

            - `forbidden`: The key lacks the permission named in
            `requiredPermission`, or the resource belongs to another workspace.

            - `workspace_pending_approval`: The workspace has not been approved
            yet.

            - `workspace_suspended`: The workspace is suspended.
        '404':
          description: >-
            - `campaign_not_found`: No campaign with that id in this workspace.

            - `not_found`: The resource does not exist in your workspace, or the
            feature is not enabled for it.
        '429':
          description: '- `rate_limited`: Too many requests.'
        '500':
          description: >-
            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Your API key, e.g. `pk_live_xxxxxxxxxxxxxxxxxxxxxxxx`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.