Get a docs project

Get a single docs project by its slug.

OAuth scopes

read

Path Parameters

slug
Type: string
required

Responses

application/json
application/json
application/json
application/json
application/json
application/json
application/json

get/v1/docs/{slug}

curl 'https://access.scalar.com/v1/docs/{slug}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

Show Schema

{
  "uid": "nanoid()",
  "name": "string",
  "slug": "string",
  "isPrivate": false,
  "accessGroups": [],
  "loginPortalUid": "",
  "activeThemeId": "",
  "agentEnabled": false,
  "analyticsEnabled": true,
  "lastPublished": null,
  "publishStatus": ""
}

Default Response

The API company.