Read complete blocks from one documentation page

Returns complete top-level canonical HTML blocks, a heading outline, or matching blocks with bounded nearby context. Continue with the opaque cursor. A changed content ETag or generation returns HTTP 409.

GET/projects/documentation/{id}/partial

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:read

AuthorizationBearer token (JWT) · headerrequired

Path parameters

idstring<uuid>required

Project documentation page UUID. Folder UUIDs are not valid for body reads.

Query parameters

modestring

Allowed:blocksoutlinematches

querystring

max length 200

contextnumber

min 0 · max 3 · default: 1

limitnumber

Maximum returned items. Blocks and matches permit 20. Outlines permit 100.

min 1 · max 100

cursorstring

Opaque cursor from the prior response.

Responses

200

blocksProjectDocumentationPartialBlockDto[]required

Show properties

Array of ProjectDocumentationPartialBlockDto

htmlstringrequired

One complete canonical top-level HTML block.

matchboolean

positionnumberrequired

Zero-based top-level block position.

contentEtagstringrequired

Unquoted SHA-256 content identity for the page content used by this read. Send it unchanged for an exact edit.

contentGenerationnumberrequired

min 1

modestringrequired

Allowed:blocksoutlinematches

nextCursorstring | nullrequired

outlineProjectDocumentationOutlineItemDto[]required

Show properties

Array of ProjectDocumentationOutlineItemDto

levelnumberrequired

positionnumberrequired

textstringrequired

HTML-escaped heading text.

pageIdstringrequired

400

Invalid page identifier, mode, query, context, limit, cursor, or an oversized page.

errorstring | object

HTTP error name or a structured HTTP exception response.

Show properties

One of:

string

string

object

object

messagestring | string[] | objectrequired

Error message, validation message list, or request-field validation message map.

Show properties

One of:

string

string

string[]

Array of string

string

object

object

statusCodenumberrequired

HTTP status code for this response.

401

Unauthorized - Invalid or missing authentication token

403

Forbidden - Insufficient API scopes or permissions

404

The page does not exist or is not accessible.

errorstring | object

HTTP error name or a structured HTTP exception response.

Show properties

One of:

string

string

object

object

messagestring | string[] | objectrequired

Error message, validation message list, or request-field validation message map.

Show properties

One of:

string

string

string[]

Array of string

string

object

object

statusCodenumberrequired

HTTP status code for this response.

409

The page content changed after the cursor was issued.

errorstring | object

HTTP error name or a structured HTTP exception response.

Show properties

One of:

string

string

object

object

messagestring | string[] | objectrequired

Error message, validation message list, or request-field validation message map.

Show properties

One of:

string

string

string[]

Array of string

string

object

object

statusCodenumberrequired

HTTP status code for this response.

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

OAuth2 access tokenRemember on this deviceInclude my values in samples

Parameters

idpath*Project documentation page UUID. Folder UUIDs are not valid for body reads.modequeryqueryquerycontextquerylimitqueryMaximum returned items. Blocks and matches permit 20. Outlines permit 100.cursorqueryOpaque cursor from the prior response.

Request

curl -X GET "https://leadtime.app/api/public/projects/documentation/550e8400-e29b-41d4-a716-446655440000/partial" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

const response = await fetch("https://leadtime.app/api/public/projects/documentation/550e8400-e29b-41d4-a716-446655440000/partial", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
  }
});

import requests

response = requests.get(
    "https://leadtime.app/api/public/projects/documentation/550e8400-e29b-41d4-a716-446655440000/partial",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN"
    },
)

Response

{
  "blocks": [
    {
      "html": "string",
      "match": true,
      "position": 0
    }
  ],
  "contentEtag": "8e2ffa0587a5c9e89d3a5228fc2b6693b8941588d06a249dd7bfb6b7e8d871a1",
  "contentGeneration": 1,
  "mode": "blocks",
  "nextCursor": "string",
  "outline": [
    {
      "level": 0,
      "position": 0,
      "text": "string"
    }
  ],
  "pageId": "string"
}

{
  "error": "string",
  "message": "string",
  "statusCode": 0
}

{
  "error": "string",
  "message": "string",
  "statusCode": 0
}

{
  "error": "string",
  "message": "string",
  "statusCode": 0
}