> ## Documentation index
> Fetch the complete documentation index at: https://context7.com/docs/llms.txt
> Ask it with GET https://context7.com/docs/ask?q=<keywords or question>. Short keywords rank best.
> Use these to discover all available pages before exploring further.
> Feature requests: https://context7.com/docs/resources/feature-requests.md lists what users asked for and how to vote for a request or add one.
> Page rating: `GET https://context7.com/docs/feedback?path=/docs/api-reference/docs7-sites/list-docs7-sites&helpful=true` (or `false`) records whether this page helped. An optional `comment` (URL-encoded, at most 500 characters) says what was missing or wrong. It is anonymous and needs no key. Comments hold no code, secrets or personal data.

# List Docs7 sites

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

`GET /v2/teamspaces/{teamspaceId}/sites`

## 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
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 created with management
      access (other keys get 403 `management_access_required`), which reaches
      only its own teamspace, 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.
  - 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."
  - 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.'
  - 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."
  - name: Ask Sites
    description: "Manage a teamspace's Context7 Ask sites: add, verify, remove, and
      read their analytics and question log"
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
      security:
        - bearerAuth: []
      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.
components:
  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.
  schemas:
    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
    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.
    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).
      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.
    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.
````
