> ## 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.

# Retrieves data from view

> Retrieves data from a specified view.

The endpoint accepts credentials on the ``Authorization-PSK`` header or
on the ``Authorization: Bearer <token>`` header. The PSK header accepts
a data-API key for this view or a user PSK. A data-API key takes
precedence over a user PSK. A user PSK or Bearer token must hold the
view's associated role.



## OpenAPI

````yaml get /api/data/{view_name}
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/data/{view_name}:
    get:
      tags:
        - Data consumer
      summary: Retrieves data from view
      description: |-
        Retrieves data from a specified view.

        The endpoint accepts credentials on the ``Authorization-PSK`` header or
        on the ``Authorization: Bearer <token>`` header. The PSK header accepts
        a data-API key for this view or a user PSK. A data-API key takes
        precedence over a user PSK. A user PSK or Bearer token must hold the
        view's associated role.
      operationId: get_data_api_data__view_name__get
      parameters:
        - name: view_name
          in: path
          required: true
          schema:
            type: string
            description: Name of the database view to retrieve data from.
            title: View Name
          description: Name of the database view to retrieve data from.
        - name: filter
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Optional filter expression to apply to the view query.
            title: Filter
          description: Optional filter expression to apply to the view query.
        - name: order
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Optional ordering clause for the result set.
            title: Order
          description: Optional ordering clause for the result set.
        - name: start
          in: query
          required: false
          schema:
            type: integer
            description: Starting offset for paginated results.
            default: 0
            title: Start
          description: Starting offset for paginated results.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            description: Maximum number of records to return.
            default: 100
            title: Limit
          description: Maximum number of records to return.
        - name: psk
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Deprecated: pass credentials via the Authorization-PSK header
              instead.
            title: Psk
          description: >-
            Deprecated: pass credentials via the Authorization-PSK header
            instead.
        - name: authorization
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Optional 'Bearer <keycloak-token>' for token-based access.
            title: Authorization
          description: Optional 'Bearer <keycloak-token>' for token-based access.
      responses:
        '200':
          description: Data retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataResponse'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad Request
        '401':
          description: 'Unauthorized: invalid credentials.'
        '404':
          description: View not found.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - 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:
    APIKeyHeader:
      type: apiKey
      in: header
      name: Authorization-PSK

````