> ## 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 Docs7 sites

> The teamspace's Docs7 sites. GitHub sites are in `data`, sites deployed with the `docs7 deploy` CLI in `localSites`. Any member.



## OpenAPI

````yaml https://context7.com/openapi.json get /v2/teamspaces/{teamspaceId}/sites
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:
    get:
      tags:
        - Docs7 Sites
      summary: List Docs7 sites
      description: >-
        The teamspace's Docs7 sites. GitHub sites are in `data`, sites deployed
        with the `docs7 deploy` CLI in `localSites`. Any member.
      operationId: listDocsSites
      parameters:
        - name: teamspaceId
          in: path
          required: true
          description: Teamspace id.
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: The sites
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Docs7SiteList'
        '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:
    Docs7SiteList:
      type: object
      required:
        - data
        - localSites
        - configuration
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Docs7Site'
        localSites:
          type: array
          items:
            $ref: '#/components/schemas/Docs7LocalSite'
        configuration:
          type: object
          required:
            - hostingZone
            - customDomainCnameTarget
          properties:
            hostingZone:
              type: string
              description: Domain of platform hostnames.
            customDomainCnameTarget:
              type: string
              description: CNAME target for a custom domain.
    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
    Docs7Site:
      type: object
      required:
        - id
        - projectId
        - repoUrl
        - docsPath
        - hosting
        - platformHostname
        - customDomainStatus
        - context7Index
        - improveSchedule
        - createdAt
        - updatedAt
      properties:
        id:
          type: string
          format: uuid
        projectId:
          type: string
          format: uuid
          description: Teamspace id.
        createdBy:
          type: string
          nullable: true
        repoUrl:
          type: string
          format: uri
        repositoryId:
          type: string
          description: GitHub repository id.
        installationId:
          type: integer
          description: GitHub App installation id.
        branch:
          type: string
          description: Pinned production branch. Null follows the default branch.
          nullable: true
        defaultBranch:
          type: string
          nullable: true
        docsPath:
          type: string
          description: Docs folder in the repository; `.` is the root.
        hosting:
          type: string
          enum:
            - 'off'
            - 'on'
          description: '`off`: added for the agents only, nothing is published.'
        analyticsUrl:
          type: string
          format: uri
          description: >-
            External docs URL for browser analytics of a site that Docs7 does
            not host.
          nullable: true
        workerName:
          type: string
        platformHostname:
          type: string
          example: acme-docs.docs7.io
        customDomain:
          type: string
          nullable: true
        customDomainPath:
          type: string
          description: Path prefix the docs are served under on the custom domain.
          nullable: true
        customDomainRouting:
          type: string
          enum:
            - dns
            - proxy
          nullable: true
        customHostnameId:
          type: string
          nullable: true
        customDomainStatus:
          type: string
          enum:
            - none
            - pending_ownership
            - pending_dns
            - pending_validation
            - pending_certificate
            - pending_proxy
            - active
            - failed
        customDomainError:
          type: string
          nullable: true
        customDomainRecords:
          type: array
          items:
            $ref: '#/components/schemas/Docs7DnsRecord'
        context7Index:
          type: boolean
          description: Whether the repository is indexed in Context7.
        context7LibraryName:
          type: string
          example: /acme/docs
        improveSchedule:
          type: string
          enum:
            - 'off'
            - daily
            - weekly
          description: How often the Context7 Agent runs on its own.
        pullRequestReview:
          $ref: '#/components/schemas/Docs7PullRequestReview'
        codeWatch:
          type: object
          required:
            - enabled
            - repositories
          properties:
            enabled:
              type: boolean
            repositories:
              type: array
              items:
                type: object
                required:
                  - repositoryId
                  - repoUrl
                properties:
                  repositoryId:
                    type: string
                  repoUrl:
                    type: string
                    format: uri
          description: >-
            Code Watch Agent settings: code repositories whose merged pull
            requests can change the docs.
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        buildFixSchedule:
          type: string
          enum:
            - 'off'
            - after_build
            - daily
            - weekly
          description: >-
            When the Build Fix Agent fixes the issues of the latest production
            build (hosted sites).
        snippetSchedule:
          type: string
          enum:
            - 'off'
            - monthly
          description: >-
            Whether the Example Check Agent runs every code example of the docs
            once a month (Docs7 Pro).
      description: A Docs7 site built from a GitHub repository.
    Docs7LocalSite:
      type: object
      required:
        - source
        - id
        - projectId
        - name
        - slug
        - platformHostname
        - createdAt
        - updatedAt
      properties:
        source:
          type: string
          enum:
            - local
        id:
          type: string
          format: uuid
        projectId:
          type: string
          format: uuid
        createdBy:
          type: string
        name:
          type: string
        slug:
          type: string
        hosting:
          type: string
          enum:
            - 'on'
        workerName:
          type: string
        platformHostname:
          type: string
        customDomain:
          type: string
          nullable: true
        customDomainPath:
          type: string
          nullable: true
        customDomainRouting:
          type: string
          nullable: true
        customHostnameId:
          type: string
          nullable: true
        customDomainStatus:
          type: string
          enum:
            - none
        customDomainError:
          type: string
          nullable: true
        customDomainRecords:
          type: array
          items:
            $ref: '#/components/schemas/Docs7DnsRecord'
          maxItems: 0
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      description: >-
        A site deployed with the `docs7 deploy` CLI. GitHub-only operations
        answer 404 for it.
    Docs7DnsRecord:
      type: object
      required:
        - purpose
        - type
        - name
        - value
      properties:
        purpose:
          type: string
          enum:
            - domain_ownership
            - tls_certificate
        type:
          type: string
          enum:
            - CNAME
            - TXT
        name:
          type: string
        value:
          type: string
      description: A DNS record to add for the custom domain.
    Docs7PullRequestReview:
      type: object
      required:
        - enabled
        - response
      properties:
        enabled:
          type: boolean
        response:
          type: string
          enum:
            - comment
            - pull_request
            - commit
          description: >-
            What the agent does with its fixes. The findings comment is always
            posted, and every check always runs.
      description: PR Review Agent settings.
  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.