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

# List what a Plot will return

> Lists the outputs a Plot produces and the columns each one is planned to have. The SQL behind it is not returned.

## Access

An MCP token or a Parable token can call this operation. See [Authentication](/getting-started/authentication.md) for the kinds of token.

Your roles must grant one of `tenant.parables.view`, `tenant.parables.manage`.

## Errors

* `PA-AU-040`: The Plot contract or definition is not conforming. Refresh the selected definition and correct the Plot contract.
* `PA-AU-001`: The Parable or Plot manifest was not found. Check the rootRefId and selected ref or Version.
* `PA-AU-019`: The caller cannot inspect this Plot. Use a Workspace identity with Parable access and the required RACI role.


## OpenAPI

````yaml /api-reference/openapi.json get /api/parable/authoring/primaries/{rootRefId}/plots/data/manifest
openapi: 3.0.3
info:
  description: >-
    Use the Workspace API to work with artifacts, connectors, Parables, and
    account resources.
  title: Workspace API
  version: v2026.10.22.1
servers: []
security: []
paths:
  /api/parable/authoring/primaries/{rootRefId}/plots/data/manifest:
    get:
      tags:
        - Parable authoring
      summary: List what a Plot will return
      description: >-
        Lists the outputs a Plot produces and the columns each one is planned to
        have. The SQL behind it is not returned.
      operationId: ParableAuthoringGetParablePlotDataManifestHandler
      parameters:
        - description: >-
            Workspace slug. Overrides subdomain-based workspace resolution when
            provided.
          in: header
          name: X-Tenant
          required: false
          schema:
            example: acme
            type: string
        - description: Optional request correlation ID echoed back in the response.
          in: header
          name: X-Request-ID
          required: false
          schema:
            example: 550e8400-e29b-41d4-a716-446655440000
            format: uuid
            type: string
        - description: rootRefId parameter
          in: path
          name: rootRefId
          required: true
          schema:
            description: UUID v4 with automatic base62 encoding for client-facing APIs
            type: string
        - in: query
          name: refId
          required: false
          schema:
            description: UUID v4 with automatic base62 encoding for client-facing APIs
            type: string
        - in: query
          name: versionId
          required: false
          schema:
            description: UUID v4 with automatic base62 encoding for client-facing APIs
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/PlotDataManifest'
                  links:
                    $ref: '#/components/schemas/ResponseLinks'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
                required:
                  - data
                  - meta
                type: object
          description: Successful response
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
          description: >-
            The request is not valid. `detail` says why. A value that breaks a
            field rule gives the code `WA-VL-001` and an `errors` member that
            names each field.
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
          description: The token is missing, malformed, revoked, or expired.
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
          description: >-
            The token cannot make this request. For example, the roles of its
            owner do not allow the operation.
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '404':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
          description: The resource that the path names was not found.
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
          description: The request failed on the server.
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
      security:
        - bearerAuth: []
      x-codeSamples:
        - label: TypeScript SDK
          lang: typescript
          source: >-
            import { WebApiSDK } from "@parable-platform/web-api-sdk";


            const sdk = new WebApiSDK({
              baseUrl: process.env.PARABLE_API_URL!,
              auth: { token: process.env.PARABLE_API_TOKEN! },
              requestInterceptor: (config) => ({
                ...config,
                headers: { ...config.headers, "X-Tenant": process.env.PARABLE_WORKSPACE! },
              }),
            });


            const query = {};

            const result = await
            sdk.parableAuthoring.getParablePlotDataManifest(
              "example",
              query
            );
        - label: Python SDK
          lang: python
          source: >-
            import os


            from parable_web_api_sdk import ClientConfig, WebApiSDK


            sdk = WebApiSDK(
                ClientConfig(
                    base_url=os.environ["PARABLE_API_URL"],
                    auth_token=os.environ["PARABLE_API_TOKEN"],
                    default_headers={"X-Tenant": os.environ["PARABLE_WORKSPACE"]},
                )
            )


            result =
            sdk.parable_authoring.get_parable_plot_data_manifest('example',
            ref_id=None, version_id=None)
        - label: Rust SDK
          lang: rust
          source: >-
            use parable_web_api_sdk::{namespaces, ClientConfig, RequestOptions,
            WebApiSdk};


            let sdk = WebApiSdk::new(ClientConfig::with_base_url(
                std::env::var("PARABLE_API_URL")?,
                Some(std::env::var("PARABLE_API_TOKEN")?),
                None,
            ))?;

            let options = RequestOptions::with_header("X-Tenant",
            std::env::var("PARABLE_WORKSPACE")?, None, None);


            let query =
            namespaces::parable_authoring::GetParablePlotDataManifestQueryParams
            {
                ref_id: None,
                version_id: None,
            };

            let result = sdk.parable_authoring.get_parable_plot_data_manifest(
                serde_json::from_value(serde_json::json!("example"))?,
                Some(&query),
                Some(&options)
            ).await?;
        - label: Go SDK
          lang: go
          source: "sdk, err := webapisdk.New(webapisdk.SDKConfig{\n\tBaseURL: os.Getenv(\"PARABLE_API_URL\"),\n\tAuth:    &webapisdk.AuthConfig{Token: os.Getenv(\"PARABLE_API_TOKEN\")},\n\tRequestInterceptor: func(ctx context.Context, req *http.Request) error {\n\t\treq.Header.Set(\"X-Tenant\", os.Getenv(\"PARABLE_WORKSPACE\"))\n\t\treturn nil\n\t},\n})\nif err != nil {\n\treturn err\n}\n\nquery := &namespaces.ParableAuthoringGetParablePlotDataManifestQueryParams{}\nresult, err := sdk.ParableAuthoringNamespace.GetParablePlotDataManifest(ctx, \"example\", query)"
components:
  schemas:
    PlotDataManifest:
      description: |-
        A Parable's data contract: the Plots it serves and their columns. It
        holds no storage location, SQL or table path.
      properties:
        contractVersion:
          type: string
        parable:
          $ref: '#/components/schemas/PlotDataManifestParable'
        plots:
          items:
            $ref: '#/components/schemas/PlotDataManifestEntry'
          type: array
        ref:
          description: Authoring or published ref this manifest was built for.
          pattern: >-
            ^([0-9A-Za-z]{1,22}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
          type: string
      required:
        - contractVersion
        - parable
        - ref
        - plots
      type: object
    ResponseLinks:
      properties:
        first:
          nullable: true
          type: string
        last:
          nullable: true
          type: string
        next:
          nullable: true
          type: string
        prev:
          nullable: true
          type: string
      type: object
    ResponseMeta:
      properties:
        requestId:
          description: Unique identifier for the request
          type: string
        totalCount:
          description: Total count of items for paginated responses
          nullable: true
          type: integer
      required:
        - requestId
      type: object
    ProblemDetails:
      description: An error response in the Problem Details format (RFC 9457).
      properties:
        code:
          description: The stable error code, when the problem has one.
          example: WA-VL-001
          type: string
        detail:
          description: What went wrong with this request.
          type: string
        details:
          description: >-
            Structured facts about the refusal, such as the entity or the path
            it concerns. Only some refusals have it.
        errors:
          description: >-
            The fields or filters that failed validation. Only a validation or
            filter error has it.
        requestId:
          description: >-
            The ID of the request, when the problem has one. The `X-Request-ID`
            response header always has it.
          type: string
        status:
          description: The HTTP status code.
          example: 400
          type: integer
        title:
          description: A short summary, usually the text of the HTTP status.
          example: Bad Request
          type: string
        type:
          description: >-
            The problem type. It is `about:blank`: the status and `code`
            identify the problem.
          example: about:blank
          type: string
      required:
        - type
        - title
        - status
        - detail
      type: object
    PlotDataManifestParable:
      properties:
        entityKey:
          description: UUID v4 with automatic base62 encoding for client-facing APIs
          pattern: >-
            ^([0-9A-Za-z]{1,22}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
          type: string
        slug:
          description: A URL friendly version of a string
          maxLength: 255
          minLength: 1
          pattern: ^[a-z0-9]+(?:[-_][a-z0-9]+)*$
          type: string
      required:
        - slug
        - entityKey
      type: object
    PlotDataManifestEntry:
      description: >-
        One Plot output in the manifest. An UNAVAILABLE entry has a non-null

        unavailableReason and no columns. An AVAILABLE entry has a null reason
        and

        the schema columns.
      properties:
        columns:
          description: Empty when UNAVAILABLE.
          items:
            $ref: '#/components/schemas/PlotDataManifestColumn'
          type: array
        entityKey:
          description: UUID v4 with automatic base62 encoding for client-facing APIs
          pattern: >-
            ^([0-9A-Za-z]{1,22}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
          type: string
        handle:
          description: >-
            A mutable camelCase code, path, and file identifier; URLs use stable
            UUIDs
          maxLength: 200
          minLength: 1
          pattern: ^[a-z][A-Za-z0-9]*$
          type: string
        outputSchemaUpdatedAt:
          description: >-
            ISO8601 datetime string. Epoch wire values keep this scalar and
            declare x-temporal-format (unix, unix_millis, unix_micros,
            unix_nanos) on the property; the unit is never guessed from digit
            count.
          format: date-time
          nullable: true
          type: string
        requiresReportingRun:
          type: boolean
        schemaStatus:
          $ref: '#/components/schemas/PlotDataSchemaStatus'
        slug:
          description: A URL friendly version of a string
          maxLength: 255
          minLength: 1
          pattern: ^[a-z0-9]+(?:[-_][a-z0-9]+)*$
          type: string
        unavailableReason:
          description: Non-null when schemaStatus is UNAVAILABLE.
          nullable: true
          type: string
      required:
        - slug
        - handle
        - entityKey
        - schemaStatus
        - columns
        - requiresReportingRun
      type: object
    PlotDataManifestColumn:
      description: Manifest column with sortability projected from scalar-lib is_sortable.
      properties:
        name:
          type: string
        primitive:
          description: >-
            The column's primitive type name: `String`, `Int`, `Float` or
            `Boolean`,

            `Unknown` when the column has no type name, or a type name that
            Parable

            does not recognize, as written.
          type: string
        scalarRef:
          description: >-
            Canonical name of a Parable scalar (e.g., Identity.UUID,
            Generic.Int64)
          maxLength: 128
          minLength: 3
          nullable: true
          pattern: ^[A-Z][A-Za-z0-9]*\.[A-Z][A-Za-z0-9]*$
          type: string
        sortable:
          description: Whether you can sort the Plot's data by this column.
          type: boolean
      required:
        - name
        - primitive
        - sortable
      type: object
    PlotDataSchemaStatus:
      enum:
        - AVAILABLE
        - UNAVAILABLE
      type: string
  headers:
    X-Request-ID:
      description: >-
        The ID of the request. It is the `X-Request-ID` value that you sent, or
        an ID that the server made. Give it when you report a problem.
      schema:
        type: string
  securitySchemes:
    bearerAuth:
      description: >-
        A personal access token, which starts with `pat_`. A Parable token can
        call each operation that the roles of its owner allow. An MCP token can
        call only the read operations that are open to agents. A SQL token does
        not work on this API.
      scheme: bearer
      type: http

````

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