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

# Get a Table Pair's read access

> The read access the Environment's workspace identity needs for an active Table Pair: Viewer on each workspace it reads outside the Environment, and Read on each Lakehouse path through a OneLake data access role. Saving a pair in the app gives this access; another client gives it in Fabric with its own access. This API never checks or changes Fabric.

Requires the GV.APIReader application role, or a higher role (Owner > Contributor > Reader).



## OpenAPI

````yaml /api/openapi.json get /api/v1/fabric/pairs/{resource_id}/read-access
openapi: 3.1.0
info:
  description: >-
    General Validation's API for Organization administration, Table Pair and
    Test authoring, Runs, and Result metadata. Microsoft Entra bearer tokens
    authorize every call.
  title: General Validation API
  version: 1.0.0
servers:
  - url: https://api.generalvalidation.com
security: []
tags:
  - description: >-
      Customer-owned Fabric references, immutable Runs, and safe Result
      summaries.
    name: Fabric
  - description: Organizations and verified membership.
    name: Organization
  - description: Subscriptions and entitlements.
    name: Billing
paths:
  /api/v1/fabric/pairs/{resource_id}/read-access:
    get:
      tags:
        - Fabric
      summary: Get a Table Pair's read access
      description: >-
        The read access the Environment's workspace identity needs for an active
        Table Pair: Viewer on each workspace it reads outside the Environment,
        and Read on each Lakehouse path through a OneLake data access role.
        Saving a pair in the app gives this access; another client gives it in
        Fabric with its own access. This API never checks or changes Fabric.


        Requires the GV.APIReader application role, or a higher role (Owner >
        Contributor > Reader).
      operationId: get_fabric_pair_read_access
      parameters:
        - description: The Table Pair's ID.
          in: path
          name: resource_id
          required: true
          schema:
            description: The Table Pair's ID.
            format: uuid
            title: Resource Id
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PairReadAccess'
          description: Successful Response
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/V1Problem'
          description: A valid Microsoft Entra bearer token is required.
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/V1Problem'
          description: The authenticated principal does not have the required role.
        '404':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/V1Problem'
          description: The resource does not exist in this tenant.
        '409':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/V1Problem'
          description: The operation conflicts with current resource or Azure state.
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/V1Problem'
          description: The request is syntactically valid but semantically invalid.
        '429':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/V1Problem'
          description: The bounded application request rate was exceeded.
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                minimum: 1
                type: integer
        '503':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/V1Problem'
          description: A required dependency is temporarily unavailable.
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                minimum: 1
                type: integer
      security:
        - entraApplication: []
components:
  schemas:
    PairReadAccess:
      additionalProperties: false
      properties:
        identity_id:
          description: >-
            The Environment's workspace identity, by service principal object
            ID.
          format: uuid
          title: Identity Id
          type: string
        workspaces:
          description: >-
            Workspaces outside the Environment that the pair reads. Empty when
            it reads only the Environment.
          items:
            $ref: '#/components/schemas/WorkspaceReadAccess'
          title: Workspaces
          type: array
      required:
        - identity_id
        - workspaces
      title: PairReadAccess
      type: object
    V1Problem:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable machine-readable error code, such as `precondition.failed`.
            Branch on this value.
          title: Code
          type: string
        detail:
          description: What went wrong in this request, written for a person.
          title: Detail
          type: string
        diagnostics:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          default: null
          description: >-
            Extra details for some errors, such as `fieldErrors` for an invalid
            request or `requiredRole` for a denied one. Absent when there are
            none.
          title: Diagnostics
        instance:
          description: Path of the request that failed.
          title: Instance
          type: string
        requestId:
          description: >-
            This request's ID, also sent in the `X-Request-Id` response header.
            Quote it when you contact support. A request that sends an
            `X-Request-Id` of 1 to 64 letters, digits, or `_.:-` gets that value
            back.
          title: Requestid
          type: string
        status:
          description: The HTTP status code of this response.
          title: Status
          type: integer
        title:
          description: Short summary of the error code.
          title: Title
          type: string
        type:
          description: Link to the documentation page for this error code.
          title: Type
          type: string
      required:
        - type
        - title
        - status
        - code
        - detail
        - instance
        - requestId
      title: V1Problem
      type: object
    WorkspaceReadAccess:
      additionalProperties: false
      properties:
        lakehouses:
          description: >-
            Lakehouses in this workspace whose paths the identity reads. Empty
            when the pair reads only a Warehouse here.
          items:
            $ref: '#/components/schemas/LakehouseReadAccess'
          title: Lakehouses
          type: array
        workspace_id:
          description: The Fabric workspace.
          format: uuid
          title: Workspace Id
          type: string
        workspace_role:
          const: Viewer
          description: The workspace role the identity needs. A higher role also works.
          title: Workspace Role
          type: string
      required:
        - workspace_id
        - workspace_role
        - lakehouses
      title: WorkspaceReadAccess
      type: object
    LakehouseReadAccess:
      additionalProperties: false
      properties:
        data_access_role:
          description: The OneLake data access role the app keeps these paths in.
          title: Data Access Role
          type: string
        lakehouse_id:
          description: The Lakehouse's item ID.
          format: uuid
          title: Lakehouse Id
          type: string
        paths:
          description: Paths as a OneLake data access role names them.
          items:
            type: string
          title: Paths
          type: array
      required:
        - lakehouse_id
        - data_access_role
        - paths
      title: LakehouseReadAccess
      type: object
  securitySchemes:
    entraApplication:
      bearerFormat: JWT
      description: >-
        Microsoft Entra application token issued by the caller's Organization
        tenant for this multitenant API. Request the .default scope and assign
        the application the required GV.APIReader, GV.APIContributor, or
        GV.APIOwner role.
      scheme: bearer
      type: http
      x-gv-app-roles:
        - GV.APIReader
        - GV.APIContributor
        - GV.APIOwner
      x-gv-audience: 78d5d8af-9dd6-49dd-b06c-38c3a3c707af
      x-gv-scope: api://78d5d8af-9dd6-49dd-b06c-38c3a3c707af/.default
      x-gv-token-url-template: https://login.microsoftonline.com/{tenantId}/oauth2/v2.0/token

````

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