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

# List recorded shipped releases

> Returns tenant-scoped shipped releases. The latest successful production/prod deployment takes precedence over a DEPLOYED transition. deployedAt is when LaneSync recorded the event; it may be null. Supply page or pageSize to apply repository and inclusive UTC date filters before pagination; undated records are excluded by date filters. Omitting both pagination parameters retains the full list without query filtering. Approval fields reflect the stored evidence record, not an immutable deployment-time snapshot.



## OpenAPI

````yaml /api-reference/openapi.json get /api/history
openapi: 3.1.0
info:
  title: LaneSync API
  description: >-
    REST API for LaneSync release governance — milestones, evidence, quality,
    and sync.
  version: 1.0.0
  contact:
    name: LaneSync
    url: https://lanesync.dev
servers:
  - url: https://lanesync.dev
    description: Hosted SaaS
security: []
tags:
  - name: Health
    description: Liveness and readiness
  - name: Auth
    description: GitHub OAuth and sessions
  - name: Dashboard
    description: Org-wide milestone views
  - name: Milestones
    description: Release pipeline and deploy gates
  - name: Repos
    description: Repository bootstrap and configuration
  - name: Sync
    description: GitHub sync triggers
  - name: Evidence
    description: CI evidence upload (no session)
  - name: Quality
    description: Quality scorecards and exports
  - name: Projects
    description: Multi-repo release projects
  - name: Team
    description: Workspace members and invites
  - name: Webhook
    description: GitHub App webhooks
  - name: Reviews
    description: Live evidence reviewer policy and eligibility
  - name: History
    description: Recorded shipped releases
  - name: MCP
    description: Remote MCP connection, OAuth, and personal keys
paths:
  /api/history:
    get:
      tags:
        - History
      summary: List recorded shipped releases
      description: >-
        Returns tenant-scoped shipped releases. The latest successful
        production/prod deployment takes precedence over a DEPLOYED transition.
        deployedAt is when LaneSync recorded the event; it may be null. Supply
        page or pageSize to apply repository and inclusive UTC date filters
        before pagination; undated records are excluded by date filters.
        Omitting both pagination parameters retains the full list without query
        filtering. Approval fields reflect the stored evidence record, not an
        immutable deployment-time snapshot.
      operationId: getReleaseHistory
      parameters:
        - $ref: '#/components/parameters/Page'
        - $ref: '#/components/parameters/PageSize'
        - name: repository
          in: query
          description: Exact owner/repo in paginated mode.
          schema:
            type: string
            example: acme/api
        - name: from
          in: query
          description: Inclusive UTC start date in paginated mode.
          schema:
            type: string
            format: date
        - name: to
          in: query
          description: Inclusive UTC end date in paginated mode. Must not precede from.
          schema:
            type: string
            format: date
      responses:
        '200':
          description: Recorded releases
          content:
            application/json:
              schema:
                type: object
                properties:
                  pagination:
                    $ref: '#/components/schemas/PageInfo'
                  repositories:
                    type: array
                    items:
                      type: string
                    description: >-
                      Repository choices from the full history collection;
                      present in paginated mode.
                  releases:
                    type: array
                    items:
                      $ref: '#/components/schemas/ReleaseHistoryRecord'
                required:
                  - releases
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          description: History could not be loaded
      security:
        - sessionCookie: []
components:
  parameters:
    Page:
      name: page
      in: query
      description: >-
        Supplying page or pageSize enables pagination. Both omitted retains the
        legacy response. Filters described as paginated-only require pagination.
      schema:
        type: integer
        minimum: 1
        maximum: 100000
        default: 1
    PageSize:
      name: pageSize
      in: query
      description: Number of rows or release groups per page.
      schema:
        type: integer
        enum:
          - 10
          - 25
          - 50
        default: 25
  schemas:
    PageInfo:
      type: object
      description: >-
        Present when page or pageSize is supplied. total counts all matches, and
        pages is at least 1 even for an empty collection. An out-of-range page
        can return no rows.
      properties:
        page:
          type: integer
          minimum: 1
          maximum: 100000
        pageSize:
          type: integer
          enum:
            - 10
            - 25
            - 50
        total:
          type: integer
          minimum: 0
        pages:
          type: integer
          minimum: 1
      required:
        - page
        - pageSize
        - total
        - pages
    ReleaseHistoryRecord:
      type: object
      properties:
        milestoneId:
          type: string
          format: uuid
        org:
          type: string
        repo:
          type: string
        version:
          type: string
        milestoneUrl:
          type:
            - string
            - 'null'
        recordUrl:
          type: string
        deployedAt:
          type:
            - string
            - 'null'
          format: date-time
        deploymentSource:
          type:
            - string
            - 'null'
          enum:
            - production_deployment
            - deployed_transition
            - null
        deploymentUrl:
          type:
            - string
            - 'null'
        candidateSha:
          type:
            - string
            - 'null'
        approval:
          type: object
          properties:
            status:
              type: string
              enum:
                - recorded
                - not_recorded
            approvedBy:
              type:
                - string
                - 'null'
            recordedAt:
              type:
                - string
                - 'null'
              format: date-time
            evidencePrUrl:
              type:
                - string
                - 'null'
          required:
            - status
            - approvedBy
            - recordedAt
            - evidencePrUrl
      required:
        - milestoneId
        - org
        - repo
        - version
        - recordUrl
        - deployedAt
        - deploymentSource
        - deploymentUrl
        - candidateSha
        - approval
    Error:
      type: object
      properties:
        error:
          type: string
  responses:
    BadRequest:
      description: Validation error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Missing or invalid session
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: Not a workspace member
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    sessionCookie:
      type: apiKey
      in: cookie
      name: connect.sid
      description: GitHub OAuth session cookie

````

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