List all docs projects

List every docs project on the team.

Query Parameters

limit
Type: integer
min:
1
max:
200

Integer numbers.

Responses

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

get/v1/docs

import Scalar from '@scalar/sdk';

const client = new Scalar({
  bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var
});

const scalarDoc = await client.scalarDocs.listProjects();

console.log(scalarDoc);

Show Schema

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

Default Response

Publish a project

Create a docs project