github

Changed on

Get a github project.

get/github/{slug}

Request

  • Base URL
    https://api.scalar.com/core
  • URL
    https://api.scalar.com/core/github/{slug}
  • Auth
    HTTP bearer

Path parameters

slugstring required

Response

Default Response

uidstring required
createdAtinteger required
updatedAtinteger required
namestring required
lastPublishedinteger required
lastPublishedUidstring nullable required
loginPortalUidstring required
userInfoHookUrlstring required
userInfoHookSecretUidstring
activeThemeIdstring required
typesenseIdnumber
isPrivateboolean required
agentEnabledboolean required
analyticsEnabledboolean required
chatInsightsEnabledboolean required
accessGroupsunknown required
slugstring required
publishStatusstring required
publishMessagestring required

Example response

{
  "uid": "UakgbKJ5m9gl0JDMbcJqL",
  "createdAt": 1735689600,
  "updatedAt": 1735689600,
  "name": "Acme Documentation",
  "activeDeployment": {
    "uid": "UakgbKJ5m9gl0JDMbcJqL",
    "domain": "docs.example.com",
    "publishedAt": 1735689600
  },
  "lastPublished": 1735689600,
  "lastPublishedUid": "PakgbKJ5m9gl0JDMbcJqL",
  "loginPortalUid": "LakgbKJ5m9gl0JDMbcJqL",
  "userInfoHookUrl": "https://example.com/hooks/user-info",
  "userInfoHookSecretUid": "UakgbKJ5m9gl0JDMbcJqL",
  "activeThemeId": "TakgbKJ5m9gl0JDMbcJqL",
  "typesenseId": 42,
  "agentEnabled": true,
  "analyticsEnabled": true,
  "chatInsightsEnabled": true,
  "accessGroups": [
    "UakgbKJ5m9gl0JDMbcJqL"
  ],
  "slug": "acme-api",
  "publishStatus": "published",
  "publishMessage": "Documentation published successfully.",
  "repository": {
    "linkedBy": "UakgbKJ5m9gl0JDMbcJqL",
    "id": 123456789,
    "name": "Acme Documentation",
    "configPath": "scalar.config.json",
    "branch": "main",
    "publishOnMerge": true,
    "publishPreviews": true,
    "prComments": true
  }
}

Changes