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

# List notebook runs

> list notebook runs. GET /api/v1/notebooks/{notebook_id}/runs. Uses the same payload, validation, revision checks and response as the unified HTTP API.

ReferenceApplies to: Unified engine deployments

## Related guidance

[Addresses and access](https://docs.e6data.com/transformation/http/access.md) · [Request identity](https://docs.e6data.com/transformation/http/request-identity.md) · [Errors and recovery](https://docs.e6data.com/transformation/http/errors.md) · [Pagination and results](https://docs.e6data.com/transformation/http/results.md)


## OpenAPI

````yaml openapi/transformation.json GET /api/v1/notebooks/{notebook_id}/runs
openapi: 3.1.0
info:
  description: >-
    HTTP contracts for the Unified engine. Requests use the connected
    deployment's access model and configured owner. Response examples are
    illustrative; inspect your engine response in your client. SQL-managed
    secrets, credentials, streaming pipelines and maintenance run through
    session operations.
  title: Laminar Unified HTTP API
  version: v1
servers:
  - url: https://engine.example.com
    description: >-
      Example engine origin. Replace it with your deployment URL and any API
      mount prefix.
security: []
paths:
  /api/v1/notebooks/{notebook_id}/runs:
    get:
      tags:
        - Notebooks
      summary: list notebook runs
      description: >-
        list notebook runs. GET /api/v1/notebooks/{notebook_id}/runs. Uses the
        same payload, validation, revision checks and response as the unified
        HTTP API.
      operationId: list_notebook_runs
      parameters:
        - in: path
          name: notebook_id
          required: true
          schema:
            format: uuid
            type: string
        - in: query
          name: after
          required: false
          schema:
            format: uuid
            type: string
        - in: query
          name: limit
          required: false
          schema:
            minimum: 1
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/app_notebooks_core_src_models_rs_NotebookRunListResponse
          description: Successful response.
        default:
          content:
            application/json:
              example:
                error:
                  code: invalid_request
                  message: Check the request fields
              schema:
                $ref: '#/components/schemas/ApiError'
          description: A rejected or failed request. Inspect error.code before retrying.
components:
  schemas:
    app_notebooks_core_src_models_rs_NotebookRunListResponse:
      properties:
        continuation:
          anyOf:
            - $ref: >-
                #/components/schemas/app_notebooks_core_src_models_rs_NotebookRunId
            - type: 'null'
        runs:
          items:
            $ref: >-
              #/components/schemas/app_notebooks_core_src_models_rs_NotebookRunSnapshot
          type: array
      required:
        - runs
        - continuation
      type: object
    ApiError:
      properties:
        error:
          properties:
            code:
              type: string
            message:
              type: string
          required:
            - code
            - message
          type: object
      required:
        - error
      type: object
    app_notebooks_core_src_models_rs_NotebookRunId:
      format: uuid
      type: string
    app_notebooks_core_src_models_rs_NotebookRunSnapshot:
      properties:
        cells:
          items:
            $ref: >-
              #/components/schemas/app_notebooks_core_src_models_rs_CellExecutionSnapshot
          type: array
        created_at:
          $ref: '#/components/schemas/shared_common_src_time_rs_WallClockTimestamp'
        document_revision:
          minimum: 0
          type: integer
        document_updated:
          type: boolean
        finished_at:
          anyOf:
            - $ref: >-
                #/components/schemas/shared_common_src_time_rs_WallClockTimestamp
            - type: 'null'
        generation:
          format: uuid
          type: string
        notebook_id:
          $ref: '#/components/schemas/app_notebooks_core_src_models_rs_NotebookId'
        parameter_definitions:
          additionalProperties:
            $ref: >-
              #/components/schemas/shared_common_src_parameters_rs_ParameterDefinition
          type: object
        parameters:
          $ref: '#/components/schemas/shared_common_src_parameters_rs_ParameterValues'
        run_id:
          $ref: '#/components/schemas/app_notebooks_core_src_models_rs_NotebookRunId'
        session_id:
          $ref: >-
            #/components/schemas/app_notebooks_core_src_models_rs_NotebookSessionId
        status:
          $ref: >-
            #/components/schemas/app_notebooks_core_src_models_rs_ExecutionStatus
      required:
        - parameters
        - parameter_definitions
        - run_id
        - notebook_id
        - session_id
        - generation
        - document_revision
        - status
        - cells
        - created_at
        - finished_at
        - document_updated
      type: object
    app_notebooks_core_src_models_rs_CellExecutionSnapshot:
      properties:
        cell_id:
          type: string
        error:
          anyOf:
            - type: string
            - type: 'null'
        execution_count:
          anyOf:
            - minimum: 0
              type: integer
            - type: 'null'
        execution_id:
          $ref: >-
            #/components/schemas/app_notebooks_core_src_models_rs_CellExecutionId
        finished_at:
          anyOf:
            - $ref: >-
                #/components/schemas/shared_common_src_time_rs_WallClockTimestamp
            - type: 'null'
        next_sequence:
          minimum: 0
          type: integer
        output_bytes:
          minimum: 0
          type: integer
        outputs_truncated:
          type: boolean
        source:
          type: string
        started_at:
          anyOf:
            - $ref: >-
                #/components/schemas/shared_common_src_time_rs_WallClockTimestamp
            - type: 'null'
        status:
          $ref: >-
            #/components/schemas/app_notebooks_core_src_models_rs_ExecutionStatus
      required:
        - execution_id
        - cell_id
        - source
        - status
        - execution_count
        - error
        - next_sequence
        - output_bytes
        - outputs_truncated
        - started_at
        - finished_at
      type: object
    shared_common_src_time_rs_WallClockTimestamp:
      properties:
        unix_millis:
          type: integer
      required:
        - unix_millis
      type: object
    app_notebooks_core_src_models_rs_NotebookId:
      format: uuid
      type: string
    shared_common_src_parameters_rs_ParameterDefinition:
      properties:
        default:
          anyOf:
            - description: JSON value; fields depend on the enclosing document or provider.
            - type: 'null'
        description:
          anyOf:
            - type: string
            - type: 'null'
        enum:
          anyOf:
            - items:
                description: >-
                  JSON value; fields depend on the enclosing document or
                  provider.
              type: array
            - type: 'null'
        nullable:
          type: boolean
        required:
          type: boolean
        type:
          $ref: '#/components/schemas/shared_common_src_parameters_rs_ParameterType'
      required:
        - type
        - required
        - nullable
      type: object
    shared_common_src_parameters_rs_ParameterValues:
      additionalProperties:
        description: JSON value; fields depend on the enclosing document or provider.
      type: object
    app_notebooks_core_src_models_rs_NotebookSessionId:
      format: uuid
      type: string
    app_notebooks_core_src_models_rs_ExecutionStatus:
      oneOf:
        - const: Queued
          type: string
        - const: Dispatching
          type: string
        - const: Running
          type: string
        - const: Succeeded
          type: string
        - const: Failed
          type: string
        - const: OutcomeUnknown
          type: string
        - const: Skipped
          type: string
    app_notebooks_core_src_models_rs_CellExecutionId:
      format: uuid
      type: string
    shared_common_src_parameters_rs_ParameterType:
      oneOf:
        - const: string
          type: string
        - const: string_array
          type: string
        - const: integer
          type: string
        - const: decimal
          type: string
        - const: boolean
          type: string
        - const: date
          type: string
        - const: timestamp
          type: string

````

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