---
title: "GET /github/{slug}"
method: GET
path: "/github/{slug}"
tags: ["github"]
---

# GET /github/{slug}

`GET /github/{slug}`

Get a github project.

## Path parameters

- `slug` string, required

## Response `200`

Default Response

- GithubProject
  - `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` GithubProjectRepository
    - `linkedBy` string, required
    - `id` number, required
    - `name` string, required
    - `configPath` string, required
    - `branch` string, required
    - `publishOnMerge` boolean, required
    - `publishPreviews` boolean, required
    - `prComments` boolean, required
    - `expired` boolean, 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/f2eb95a82c72/schema)