---
title: "GET /docs-projects/{slug}"
method: GET
path: "/docs-projects/{slug}"
---

# GET /docs-projects/{slug}

`GET /docs-projects/{slug}`

Get a unified DocsProject by slug for the current team

## Path parameters

- `slug` string, required

## Response `200`

Default Response

- DocsProject
  - `uid` string, required
  - `createdAt` integer, required
  - `updatedAt` integer, required
  - `name` string, required
  - `activeDeployment` ActiveDeployment, required
    - `uid` string, required
    - `domain` string, required
    - `publishedAt` integer, required
  - `lastPublished` integer, required
  - `lastPublishedUid` string, nullable, required
  - `loginPortalUid` string, required
  - `activeThemeId` string, required
  - `typesenseId` number
  - `isPrivate` boolean, required
  - `agentEnabled` boolean, required
  - `analyticsEnabled` boolean, required
  - `accessGroups` unknown, required
  - `slug` string, required
  - `publishStatus` string, required
  - `publishMessage` string, required
  - `repository` union, required
    - DocsProjectRepositoryForgejo
      - `provider` 'forgejo', required
      - `forgejoOwner` string, required
      - `forgejoRepo` string, required
      - `branch` string, required
      - `configPath` string, required
    - DocsProjectRepositoryGithub
      - `provider` 'github', required
      - `linkedBy` string, required
      - `installationId` integer, required
      - `id` integer, required
      - `name` string, required
      - `branch` string, required
      - `configPath` string, required
      - `publishOnMerge` boolean, required
      - `publishPreviews` boolean, required
      - `prComments` boolean, required
      - `expired` boolean, required
    - DocsProjectRepositoryBitbucket
      - `provider` 'bitbucket', required
      - `linkedBy` string, required
      - `workspaceUuid` string, required
      - `workspaceSlug` string, required
      - `repoUuid` string, required
      - `repoSlug` string, required
      - `name` string, required
      - `branch` string, required
      - `configPath` string, required
      - `publishOnMerge` boolean, required
      - `publishPreviews` boolean, required
      - `prComments` boolean, required
      - `expired` boolean, required
      - `webhookUuid` string, required
  - `remoteActivity` DocsProjectRemoteActivity
    - `at` integer, required
    - `branch` string, nullable, required
    - `sha` string, nullable, required
    - `actorName` string, nullable, required

## Other responses

- `400` — Bad request
- `401` — No auth
- `403` — Forbidden
- `404` — Not found
- `422` — Invalid payload
- `500` — Uncaught error

---

[API](https://skmtc.net/scalar/apis/core.md) · [All operations](https://skmtc.net/scalar/apis/core/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/scalar/core/versions/8dff1e93bc68/schema)