List all projects

List all guide projects.

OAuth scopes

platform:read

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 scalarDoc = await client.scalarDocs.listGuides();

console.log(scalarDoc);

Show Schema

[
  {
    "uid": "UakgbKJ5m9gl0JDMbcJqL",
    "createdAt": 1735689600,
    "updatedAt": 1735689600,
    "name": "Acme Documentation",
    "activeDeployment": null,
    "lastPublished": null,
    "lastPublishedUid": "PakgbKJ5m9gl0JDMbcJqL",
    "loginPortalUid": "LakgbKJ5m9gl0JDMbcJqL",
    "userInfoHookUrl": "https://example.com/hooks/user-info",
    "userInfoHookSecretUid": "UakgbKJ5m9gl0JDMbcJqL",
    "activeThemeId": "TakgbKJ5m9gl0JDMbcJqL",
    "typesenseId": 42,
    "isPrivate": false,
    "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,
      "expired": false
    }
  }
]

Default Response

Scalar Docs

Create a project

The API company.