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

# List Rows

> Returns a paginated list of rows from the worksheet. Results are returned in a 'data' envelope with pagination metadata in 'meta'.



## OpenAPI

````yaml GET /{endpointNamespace}/{projectName}/{tabSlug}
openapi: 3.0.3
info:
  title: Sheet Ninja API
  description: >-
    The official API for Sheet Ninja, turning Google Sheets into RESTful
    endpoints. Supports hierarchical routing, bulk operations, and camelCase
    header mapping.
  version: 1.0.0
  contact:
    name: Sheet Ninja Support
    url: https://sheetninja.io
servers:
  - url: https://api.sheetninja.io
    description: Production Server
security: []
paths:
  /{endpointNamespace}/{projectName}/{tabSlug}:
    parameters:
      - name: endpointNamespace
        in: path
        required: true
        description: Your unique user namespace (e.g., c01c052...)
        schema:
          type: string
      - name: projectName
        in: path
        required: true
        description: The slugified name of your project
        schema:
          type: string
      - name: tabSlug
        in: path
        required: true
        description: The slugified name of the specific worksheet (tab)
        schema:
          type: string
    get:
      tags:
        - Rows
      summary: List Rows
      description: >-
        Returns a paginated list of rows from the worksheet. Results are
        returned in a 'data' envelope with pagination metadata in 'meta'.
      parameters:
        - name: limit
          in: query
          description: 'Number of rows to return per page (Default: 100 for Trial)'
          schema:
            type: integer
            default: 100
        - name: offset
          in: query
          description: Number of rows to skip (0-indexed)
          schema:
            type: integer
            default: 0
      responses:
        '200':
          description: The row data will be returned to you as JSON along with the row ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SheetResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '402':
          $ref: '#/components/responses/PaymentRequiredError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/RateLimitError'
        '500':
          $ref: '#/components/responses/ServerError'
        '504':
          $ref: '#/components/responses/GatewayTimeoutError'
      security:
        - bearerAuth: []
        - {}
components:
  schemas:
    SheetResponse:
      type: object
      description: >-
        Enveloped response containing the requested worksheet data and
        pagination metadata
      properties:
        data:
          type: array
          description: An array of row objects corresponding to the Google Sheet rows
          items:
            type: object
            additionalProperties: true
            properties:
              id:
                type: integer
                description: The physical row number in the spreadsheet
        meta:
          $ref: '#/components/schemas/PaginationMeta'
          description: Metadata for handling paginated results
    PaginationMeta:
      type: object
      description: Details about the current page and pointers for the next set of results
      properties:
        limit:
          type: integer
          description: The maximum number of rows returned in this response
        offset:
          type: integer
          description: The starting point (index) of the current page of results
        has_more:
          type: boolean
          description: True if there are more rows available beyond the current page
        next_offset:
          type: integer
          nullable: true
          description: >-
            The offset value to use in your next request to fetch the subsequent
            page
    ErrorResponse:
      type: object
      description: Standardized error structure returned for non-2xx responses
      properties:
        error:
          type: string
          description: The machine-readable error code
          enum:
            - not_found
            - unauthorized
            - forbidden
            - disabled
            - invalid
            - conflict
            - quota_exceeded
            - google_token_invalid
            - google_unsupported_document
            - google_rate_limit_exceeded
            - google_permission_denied
            - google_sheet_not_found
            - google_timeout
            - internal_server_error
            - encoding_failed
        message:
          type: string
          description: A human-readable explanation of what went wrong
        data:
          type: object
          nullable: true
          description: Optional additional context or metadata regarding the error
  responses:
    UnauthorizedError:
      description: Authentication failed, token is missing.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    PaymentRequiredError:
      description: Row quota exceeded (Subscription or Credits).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    ForbiddenError:
      description: >-
        Invalid token, insufficient permissions, or the project/operation is
        disabled.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFoundError:
      description: The requested namespace, project, tab, or row was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    RateLimitError:
      description: Google Sheets API rate limits exceeded.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    ServerError:
      description: An unexpected internal server error occurred.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    GatewayTimeoutError:
      description: Google Sheets took too long to respond. Pagination is recommended.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Token
      description: >-
        The Bearer Token associated with your endpoint. This is only required if
        you have enabled protection for this endpoint.

````