List generated doc pages

1 parameter

projectIdstringrequired

The project's ID, from listProjects.

3 status codes

200The pages.

pagesarray<object>required

401The API key is missing or invalid.

errorobjectrequired

404The project or resource does not exist in this organisation.

errorobjectrequired

Error handling

A 401 is returned: The API key is missing or invalid. A 404 is returned: The project or resource does not exist in this organisation.

import { Octri } from "octri-api-sdk";

const client = new Octri({
  baseUrl: "https://api.octri.dev",
  auth: { apiKeyAuth: process.env.OCTRI_API_KEY! },
});

const result = await client.docs.listPages({ projectId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21" });

{
  "pages": [
    {
      "generationStatus": "example_value",
      "hasUnpublishedChanges": true,
      "method": "example_value",
      "path": "example_value",
      "slug": "my-example-resource",
      "title": "Example Title",
      "type": "standard"
    }
  ]
}

Request

Response

Errors