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

# List deployments

> One page (20 builds, newest first) of the site's build history, with its live targets. Any member. Only for GitHub sites: a CLI site (`source: "local"`) answers 404.



## OpenAPI

````yaml https://context7.com/openapi.json get /v2/teamspaces/{teamspaceId}/sites/{siteId}/deployments
openapi: 3.0.0
info:
  title: Context7 Public API
  description: >-
    The Context7 Public API provides programmatic access to library
    documentation and search functionality. Get up-to-date documentation and
    code examples for any library.
  version: 2.0.0
  contact:
    name: Context7 Support
    url: https://context7.com
    email: support@context7.com
servers:
  - url: https://context7.com/api
    description: Production server
security: []
tags:
  - name: Search
    description: Search for libraries in the Context7 database
  - name: Context
    description: Retrieve documentation context for queries
  - name: Ask
    description: Answer questions from a website registered with Context7 Ask
  - name: Refresh
    description: Refresh existing libraries to fetch latest documentation
  - name: Policies
    description: Manage teamspace access policies and filters
  - name: Add Library
    description: Submit new libraries for documentation processing
  - name: Metrics
    description: Retrieve usage metrics for libraries
  - name: Usage
    description: See member and teamspace API usage
  - name: Teamspaces
    description: >-
      Teamspaces the caller is a member of. The management API
      (`/v2/teamspaces/*`) accepts a Context7 API key, which reaches only its
      own teamspace and can make changes or read personal data only when it was
      created with write access (other keys can only read and get 403
      `write_access_required` on writes and on personal data), or an OAuth token
      issued for the Context7 Admin MCP server
      (`https://admin.mcp.context7.com/mcp`), which reaches every teamspace of
      the user. A browser session is not accepted.
  - name: Teamspace Admin
    description: >-
      Members, invitations, rules, library policies and requests, usage and the
      spending limit of a teamspace. Every API key can read rules, policies,
      usage and the spending limit. Changes, and reading members, invitations,
      the invite link and library requests (they name people), need an API key
      created with **Write access** ticked (other keys get 403
      `write_access_required`), or the Context7 Admin MCP sign-in.
  - name: Teamspace Libraries
    description: >-
      A teamspace's libraries: its private sources and the libraries it has
      claimed. Add, refresh, configure, version, claim and remove them, and read
      their parse state and usage. A library id `/owner/repo` is two path
      segments. Every API key can read. Changes need an API key created with
      **Write access** ticked (other keys get 403 `write_access_required`), or
      the Context7 Admin MCP sign-in.
  - name: Docs7 Sites
    description: >-
      Docs7 documentation sites of a teamspace: settings, custom domains,
      deployments, previews and the Docs7 agents. Any member can read; owners
      and admins can change; developers can add a site, publish one added for
      the agents only, and rebuild. Sites deployed with the `docs7 deploy` CLI
      have `source: "local"`; operations marked GitHub-only answer 404 for them.
      Every API key can read, except feature requests and the GitHub account
      behind a build (personal data). Changes, and those reads, need an API key
      created with **Write access** ticked (other keys get 403
      `write_access_required`), or the Context7 Admin MCP sign-in.
  - name: Docs7 Analytics
    description: >-
      Traffic of one Docs7 site: visitors, AI crawlers, searches, assistant
      questions and page feedback. Docs7 Free reads the last 7 days, Docs7 Pro
      the last 90. Every API key can read the visitor, crawler and path reports.
      Searches, questions, conversations, feedback and the raw records
      (`explore`) are personal data and need an API key created with **Write
      access** ticked, or the Context7 Admin MCP sign-in.
  - name: Ask Sites
    description: >-
      Manage a teamspace's Context7 Ask sites: add, verify, remove, and read
      their analytics and question log. Every API key can read the sites.
      Changes, and reading the analytics and question log (visitor questions),
      need an API key created with **Write access** ticked (other keys get 403
      `write_access_required`), or the Context7 Admin MCP sign-in.
paths:
  /v2/teamspaces/{teamspaceId}/sites/{siteId}/deployments:
    get:
      tags:
        - Docs7 Sites
      summary: List deployments
      description: >-
        One page (20 builds, newest first) of the site's build history, with its
        live targets. Any member. Only for GitHub sites: a CLI site (`source:
        "local"`) answers 404.
      operationId: listDocsDeployments
      parameters:
        - name: teamspaceId
          in: path
          required: true
          description: Teamspace id.
          schema:
            type: string
            format: uuid
        - name: siteId
          in: path
          required: true
          description: Docs7 site id.
          schema:
            type: string
            format: uuid
        - name: page
          in: query
          required: false
          description: Zero-based page.
          schema:
            type: integer
            minimum: 0
            default: 0
      responses:
        '200':
          description: A page of deployments
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Docs7DeploymentPage'
        '400':
          description: Invalid teamspace or site id
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Docs7Error'
              example:
                error: invalid_id
                message: Invalid site id.
        '401':
          description: Missing or invalid bearer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Docs7Error'
              example:
                error: unauthorized
                message: Authentication required.
        '403':
          description: Not a member, missing role, or an API key of another teamspace
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Docs7Error'
              example:
                error: forbidden
                message: You do not have permission to do this.
        '404':
          description: No such site in this teamspace
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Docs7Error'
              example:
                error: not_found
                message: Site not found.
        '500':
          description: Internal error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Docs7Error'
              example:
                error: internal_error
                message: Internal server error.
      security:
        - bearerAuth: []
components:
  schemas:
    Docs7DeploymentPage:
      type: object
      required:
        - data
        - targets
        - setupNotice
        - page
        - totalCount
        - totalPages
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Docs7Deployment'
        targets:
          type: array
          items:
            $ref: '#/components/schemas/Docs7DeploymentTarget'
        setupNotice:
          type: object
          properties:
            id:
              type: string
            kind:
              type: string
              enum:
                - intercom_trusted_domain
            hostnames:
              type: array
              items:
                type: string
            intercomAppId:
              type: string
          description: A setup step the live build needs. Only on page 0.
          nullable: true
        page:
          type: integer
          minimum: 0
        totalCount:
          type: integer
          minimum: 0
        totalPages:
          type: integer
          minimum: 1
    Docs7Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Error code (snake_case).
        message:
          type: string
          description: Human-readable message. Most errors have one.
        details:
          type: object
          description: Validation details on `invalid_payload`.
      description: Docs7 error response
    Docs7Deployment:
      type: object
      required:
        - id
        - siteId
        - hostname
        - target
        - trigger
        - state
        - createdAt
      properties:
        id:
          type: string
          format: uuid
        siteId:
          type: string
          format: uuid
        hostname:
          type: string
        workerName:
          type: string
        target:
          type: string
          enum:
            - production
            - preview
        branch:
          type: string
          description: Preview branch; null for production.
          nullable: true
        trigger:
          type: string
          enum:
            - connect
            - manual
            - push
            - pull_request
        state:
          type: string
          enum:
            - queued
            - building
            - succeeded
            - failed
            - canceled
        sourceKind:
          type: string
          enum:
            - git
            - cli
        attributionRequired:
          type: boolean
        requestedCommitSha:
          type: string
          nullable: true
        commitSha:
          type: string
          nullable: true
        commitMessage:
          type: string
          nullable: true
        triggeredBy:
          type: string
          description: User id when a member started the build.
          nullable: true
        createdAt:
          type: string
          format: date-time
        startedAt:
          type: string
          format: date-time
          nullable: true
        completedAt:
          type: string
          format: date-time
          nullable: true
        failure:
          type: object
          required:
            - kind
            - message
          properties:
            kind:
              type: string
              enum:
                - content
                - configuration
                - source
                - capacity
                - platform
            message:
              type: string
          description: Only on a failed build.
        cancellation:
          type: object
          required:
            - reason
          properties:
            reason:
              type: string
              enum:
                - superseded
                - preview_removed
                - site_removed
                - target_changed
            replacementDeploymentId:
              type: string
              format: uuid
          description: Only on a canceled build.
    Docs7DeploymentTarget:
      type: object
      required:
        - hostname
        - branch
        - liveDeploymentId
        - publicUrl
      properties:
        hostname:
          type: string
        workerName:
          type: string
        branch:
          type: string
          description: Null for production.
          nullable: true
        liveDeploymentId:
          type: string
          format: uuid
          nullable: true
        publicUrl:
          type: string
          format: uri
          nullable: true
        customDomainRouting:
          type: string
          enum:
            - dns
            - proxy
          nullable: true
      description: A production or preview target and its live build.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Get your API key at
        [context7.com/dashboard](https://context7.com/dashboard). Treat your API
        key like a password and store it securely. Every key can read the
        management API (`/v2/teamspaces/*`), except personal data: member and
        invitation emails, library requesters, visitor questions, Docs7 reader
        searches, conversations, feedback and feature requests, and the GitHub
        account behind a build. To read those or make changes there, the key
        must be created with **Write access** ticked; other keys get 403
        `write_access_required`.

````

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