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

# Get preview for a table in a catalog

> Get a preview for a desired table in a catalog.



## OpenAPI

````yaml get /api/metastore/catalogs/{catalog_name}/schemas/{schema_name}/tables/{table_name}/preview
openapi: 3.1.0
info:
  title: Nx1 AI API
  description: |

    AI API for Nx1 Data Platform Management and Automated Data Tasks.

    Authentication is required via PSK in Authorization header.

    Default PSK is | [ask a friend] |
  version: 0.10.2
servers: []
security: []
paths:
  /api/metastore/catalogs/{catalog_name}/schemas/{schema_name}/tables/{table_name}/preview:
    get:
      tags:
        - Metastore
      summary: Get preview for a table in a catalog
      description: Get a preview for a desired table in a catalog.
      operationId: >-
        get_table_preview_api_metastore_catalogs__catalog_name__schemas__schema_name__tables__table_name__preview_get
      parameters:
        - name: catalog_name
          in: path
          required: true
          schema:
            type: string
            description: Catalog name.
            title: Catalog Name
          description: Catalog name.
        - name: schema_name
          in: path
          required: true
          schema:
            type: string
            description: Schema name.
            title: Schema Name
          description: Schema name.
        - name: table_name
          in: path
          required: true
          schema:
            type: string
            description: Table name.
            title: Table Name
          description: Table name.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 500
            minimum: 1
            description: Maximum number of rows to return.
            default: 20
            title: Limit
          description: Maximum number of rows to return.
      responses:
        '200':
          description: Table altered successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - OAuth2AuthorizationCodeBearer: []
        - APIKeyHeader: []
components:
  schemas:
    DataResponse:
      properties:
        start:
          type: integer
          title: Start
          description: >-
            The starting offset for pagination when returning a subset of the
            dataset.
        row_count:
          type: integer
          title: Row Count
          description: The number of rows included in the current response.
        next_start:
          anyOf:
            - type: integer
            - type: 'null'
          title: Next Start
          description: >-
            The offset value for the next page of data, if additional results
            are available.
        columns:
          items:
            type: string
          type: array
          title: Columns
          description: >-
            A list of column names representing the structure of the returned
            dataset.
        data:
          anyOf:
            - items:
                items: {}
                type: array
              type: array
            - type: 'null'
          title: Data
          description: >-
            The actual tabular data returned, where each inner list represents a
            row of values.
      type: object
      required:
        - start
        - row_count
        - columns
      title: DataResponse
    ErrorResponse:
      properties:
        error:
          type: string
          title: Error
          description: A brief description of the error that occurred.
        code:
          type: integer
          title: Code
          description: The HTTP status code associated with the error.
          default: 500
      type: object
      required:
        - error
      title: ErrorResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    OAuth2AuthorizationCodeBearer:
      type: oauth2
      flows:
        authorizationCode:
          scopes: {}
          authorizationUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/auth
          tokenUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/token
    APIKeyHeader:
      type: apiKey
      in: header
      name: Authorization-PSK

````