---
title: "Get a Docs7 site"
method: GET
path: "/v2/teamspaces/{teamspaceId}/sites/{siteId}"
tags: ["Docs7 Sites"]
---

# Get a Docs7 site

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

## Request

- Base URL: `https://context7.com/api`
- URL: `https://context7.com/api/v2/teamspaces/{teamspaceId}/sites/{siteId}`
- Auth: HTTP bearer

One site, GitHub or CLI. Any member.

## Path parameters

- `teamspaceId` string, uuid, required
- `siteId` string, uuid, required

## Response `200`

The site

- object
  - `data` union, required
    - Docs7Site: A Docs7 site built from a GitHub repository.
      - `id` string, uuid, required
      - `projectId` string, uuid, required: Teamspace id.
      - `createdBy` string, nullable
      - `repoUrl` string, uri, required
      - `repositoryId` string: GitHub repository id.
      - `installationId` integer: GitHub App installation id.
      - `branch` string, nullable: Pinned production branch. Null follows the default branch.
      - `defaultBranch` string, nullable
      - `docsPath` string, required: Docs folder in the repository; `.` is the root.
      - `hosting` 'off' | 'on', required: `off`: added for the agents only, nothing is published.
      - `analyticsUrl` string, uri, nullable: External docs URL for browser analytics of a site that Docs7 does not host.
      - `workerName` string
      - `platformHostname` string, required
      - `customDomain` string, nullable
      - `customDomainPath` string, nullable: Path prefix the docs are served under on the custom domain.
      - `customDomainRouting` 'dns' | 'proxy', nullable
      - `customHostnameId` string, nullable
      - `customDomainStatus` 'none' | 'pending_ownership' | 'pending_dns' | 'pending_validation' | 'pending_certificate' | 'pending_proxy' | 'active' | 'failed', required
      - `customDomainError` string, nullable
      - `customDomainRecords` Docs7DnsRecord[]
        - `purpose` 'domain_ownership' | 'tls_certificate', required
        - `type` 'CNAME' | 'TXT', required
        - `name` string, required
        - `value` string, required
      - `context7Index` boolean, required: Whether the repository is indexed in Context7.
      - `context7LibraryName` string
      - `improveSchedule` 'off' | 'daily' | 'weekly', required: How often the Context7 Agent runs on its own.
      - `pullRequestReview` Docs7PullRequestReview: PR Review Agent settings.
        - `enabled` boolean, required
        - `response` 'comment' | 'pull_request' | 'commit', required: What the agent does with its fixes. The findings comment is always posted, and every check always runs.
      - `codeWatch` object: Code Watch Agent settings: code repositories whose merged pull requests can change the docs.
        - `enabled` boolean, required
        - `repositories` object[], required
          - `repositoryId` string, required
          - `repoUrl` string, uri, required
      - `createdAt` string, date-time, required
      - `updatedAt` string, date-time, required
      - `buildFixSchedule` 'off' | 'after_build' | 'daily' | 'weekly': When the Build Fix Agent fixes the issues of the latest production build (hosted sites).
      - `snippetSchedule` 'off' | 'monthly': Whether the Example Check Agent runs every code example of the docs once a month (Docs7 Pro).
    - Docs7LocalSite: A site deployed with the `docs7 deploy` CLI. GitHub-only operations answer 404 for it.
      - `source` 'local', required
      - `id` string, uuid, required
      - `projectId` string, uuid, required
      - `createdBy` string
      - `name` string, required
      - `slug` string, required
      - `hosting` 'on'
      - `workerName` string
      - `platformHostname` string, required
      - `customDomain` string, nullable
      - `customDomainPath` string, nullable
      - `customDomainRouting` string, nullable
      - `customHostnameId` string, nullable
      - `customDomainStatus` 'none'
      - `customDomainError` string, nullable
      - `customDomainRecords` Docs7DnsRecord[]
        - `purpose` 'domain_ownership' | 'tls_certificate', required
        - `type` 'CNAME' | 'TXT', required
        - `name` string, required
        - `value` string, required
      - `createdAt` string, date-time, required
      - `updatedAt` string, date-time, required

## Other responses

- `400`: Invalid teamspace or site id
- `401`: Missing or invalid bearer
- `403`: Not a member, missing role, or an API key of another teamspace
- `404`: No such site in this teamspace
- `500`: Internal error

## Changes

- **2026-10-27** `2ead96d131a7`: 1 info
  - added the optional property `data/oneOf[#/components/schemas/Docs7Site]/snippetSchedule` to the response with the `200` status
- **2026-10-22** `e17589fd8767`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/context7/apis/context7-public-api/changes/v2/teamspaces/:teamspaceId/sites/:siteId/get.md)

---

[API](https://skmtc.dev/context7/apis/context7-public-api.md) - [All operations](https://skmtc.dev/context7/apis/context7-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/context7/apis/context7-public-api/revisions/945f7834fa8c?raw)