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

# List sheets

> Returns a paginated list of sheets owned by the authenticated API user.



## OpenAPI

````yaml GET /1.1/sheet
openapi: 3.0.0
info:
  title: CSVBox Sheets API Documentation
  description: >-
    CSVBox public API for creating sheets and defining column rules,
    destinations, settings, and JavaScript virtual columns, validation functions
    and data transforms.
  version: 1.2.0
servers:
  - url: https://api.csvbox.io/
    description: CSVBox Sheets API Server
security: []
tags:
  - name: Sheets
    description: Sheets
paths:
  /1.1/sheet:
    get:
      tags:
        - Sheets
      summary: List Sheets
      description: Returns a paginated list of sheets owned by the authenticated API user.
      operationId: listSheets
      parameters:
        - $ref: '#/components/parameters/AcceptHeader'
        - name: page
          in: query
          description: Page number (1-indexed). Defaults to 1.
          required: false
          schema:
            type: integer
            minimum: 1
        - name: per_page
          in: query
          description: Sheets per page. Defaults to 20, clamped to a maximum of 100.
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
      responses:
        '200':
          description: Paginated list of sheets
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SheetListResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - ApiKeyAuth: []
          ApiSecretKeyAuth: []
components:
  parameters:
    AcceptHeader:
      name: Accept
      in: header
      description: Must be application/json
      required: true
      schema:
        type: string
        example: application/json
  schemas:
    SheetListResponse:
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/SheetListItem'
        links:
          properties:
            first:
              type: string
            last:
              type: string
            prev:
              type: string
              nullable: true
            next:
              type: string
              nullable: true
          type: object
        meta:
          properties:
            current_page:
              type: integer
              example: 1
            from:
              type: integer
              example: 1
            last_page:
              type: integer
              example: 3
            per_page:
              type: integer
              example: 20
            to:
              type: integer
              example: 20
            total:
              type: integer
              example: 42
          type: object
      type: object
    ErrorResponse:
      properties:
        status:
          type: string
          example: Sheet Creation Failed
        errors:
          description: >-
            Keys are dotted paths into the request body (for example
            `virtual_columns.0.js_code`), each mapping to a list of problems
            found at that path. Every failing item is reported in one response,
            so a caller pushing ten functions learns about all ten in a single
            round trip. Requests rejected by the JavaScript gate always use this
            form, and point into that item's own js_code: `line` is 1-based,
            `column` is 0-based. `identifier`, `line` and `column` are present
            only when the violation has one. Codes: js_code_too_long,
            js_forbidden_sequence, js_syntax_error, js_disallowed_global,
            js_forbidden_construct, js_duplicate_name, js_name_conflicts_column,
            js_unknown_column, js_too_many_items, js_budget_exceeded,
            js_name_ambiguous, js_missing_name, js_unknown_field,
            js_invalid_field, js_invalid_item, dependency_url_invalid,
            dependency_host_not_allowed, column_name_ambiguous.
          type: object
          example:
            virtual_columns.0.js_code:
              - code: js_disallowed_global
                message: >-
                  Disallowed global `fetch`. Snippets may only reference the
                  `csvbox` argument, standard built-ins, and globals declared in
                  this item's dependencies.
                identifier: fetch
                line: 1
                column: 7
          additionalProperties:
            type: array
            items:
              type: object
              properties:
                code:
                  type: string
                  example: js_disallowed_global
                message:
                  type: string
                  example: >-
                    Disallowed global `fetch`. Snippets may only reference the
                    `csvbox` argument, standard built-ins, and globals declared
                    in this item's dependencies.
                identifier:
                  type: string
                  example: fetch
                line:
                  type: integer
                  example: 1
                column:
                  type: integer
                  example: 7
      type: object
    SheetListItem:
      description: >-
        Summary shape returned by GET /1.1/sheet (list). Call GET
        /1.1/sheet/{sheet_license_key} for full detail (columns, JS collections,
        destination, webhooks, security_settings, display, steps) on one sheet.
      properties:
        sheet_id:
          type: integer
          example: 123
        sheet_license_key:
          type: string
          example: a1b2c3d4
        title:
          type: string
          example: Customer Import
        created_via:
          type: string
        columns_count:
          type: integer
        import_count:
          type: integer
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      type: object
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      name: x-csvbox-api-key
      in: header
    ApiSecretKeyAuth:
      type: apiKey
      name: x-csvbox-secret-api-key
      in: header

````

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