List all projects

List all guide projects.

Responses

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

get/v1/guides

import Scalar from "@scalar/sdk";

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

const listGuides = await client.scalarDocs.listGuides();
console.log(listGuides);

Show Schema

[
  {
    "uid": "nanoid()",
    "createdAt": 0,
    "updatedAt": 0,
    "name": "string",
    "activeDeployment": null,
    "lastPublished": null,
    "lastPublishedUid": null,
    "loginPortalUid": "",
    "activeThemeId": "",
    "typesenseId": 1,
    "isPrivate": false,
    "agentEnabled": false,
    "accessGroups": [],
    "slug": "string",
    "publishStatus": "",
    "publishMessage": "",
    "repository": {
      "linkedBy": "string",
      "id": 1,
      "name": "string",
      "configPath": "",
      "branch": "",
      "publishOnMerge": false,
      "publishPreviews": false,
      "prComments": false,
      "expired": false
    }
  }
]

Default Response

The API company.