Get a docs project

Get a single docs project by its slug.

OAuth scopes

platform: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/acme-docs \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

Show Schema

{
  "uid": "UakgbKJ5m9gl0JDMbcJqL",
  "name": "Acme Documentation",
  "slug": "acme-api",
  "isPrivate": false,
  "accessGroups": [
    "UakgbKJ5m9gl0JDMbcJqL"
  ],
  "loginPortalUid": "LakgbKJ5m9gl0JDMbcJqL",
  "activeThemeId": "TakgbKJ5m9gl0JDMbcJqL",
  "agentEnabled": true,
  "analyticsEnabled": true,
  "lastPublished": null,
  "publishStatus": "published"
}

Default Response

Create a docs project

Delete a docs project

The API company.