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

# List Grids



## OpenAPI

````yaml https://clientapi.retailgrid.io/openapi.json get /v1/grids
openapi: 3.1.0
info:
  title: Retailgrid Public API
  version: v1
servers: []
security: []
paths:
  /v1/grids:
    get:
      tags:
        - grids
      summary: List Grids
      operationId: list_grids_v1_grids_get
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
            title: Page
        - name: page_size
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            default: 20
            title: Page Size
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GridListResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    GridListResponse:
      properties:
        grids:
          items:
            $ref: '#/components/schemas/GridListItem'
          type: array
          title: Grids
        page:
          type: integer
          title: Page
        page_size:
          type: integer
          title: Page Size
        total:
          type: integer
          title: Total
        has_more:
          type: boolean
          title: Has More
      additionalProperties: false
      type: object
      required:
        - page
        - page_size
        - total
        - has_more
      title: GridListResponse
      description: '``GET /v1/grids`` — page/page_size paginated list of the caller''s grids.'
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    GridListItem:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        name:
          type: string
          title: Name
        status:
          type: string
          title: Status
        row_count:
          type: integer
          title: Row Count
        column_count:
          type: integer
          title: Column Count
          description: >-
            Total columns: canonical (product/variant) plus user-defined custom
            and calculated columns. Identical in the list and export responses.
        tags:
          items:
            type: string
          type: array
          title: Tags
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
      additionalProperties: false
      type: object
      required:
        - id
        - name
        - status
        - row_count
        - column_count
        - created_at
        - updated_at
      title: GridListItem
      description: Metadata-only entry in the grid list envelope — never carries rows.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````