Get a docs project
Get a single docs project by its slug.
Path Parameters
- Type: stringslugrequired
Responses
- application/json
- application/json
- application/json
- application/json
- application/json
- application/json
- application/json
Request Example for get/v1/docs/{slug}
import Scalar from '@scalar/sdk';
const client = new Scalar({
bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var
});
const docsProject = await client.scalarDocs.retrieveProject('acme-docs');
console.log(docsProject);
{
"uid": "UakgbKJ5m9gl0JDMbcJqL",
"name": "Acme Documentation",
"slug": "acme-api",
"isPrivate": false,
"accessGroups": [
"UakgbKJ5m9gl0JDMbcJqL"
],
"loginPortalUid": "LakgbKJ5m9gl0JDMbcJqL",
"activeThemeId": "TakgbKJ5m9gl0JDMbcJqL",
"agentEnabled": true,
"analyticsEnabled": true,
"lastPublished": null,
"publishStatus": "published"
}
