Leadtime icon

Leadtime

Interact with Leadtime ERP API

Actions180

Project Documentation → Read Page Blocks

AI-generated

Summary

Read a project documentation page by its documentation node UUID, returning blocks, a heading outline, or blocks that match a query. Use the read cursor from a prior response to continue paginated reads.

Inputs

  • Documentation ID (required) — UUID of the documentation page; project short identifiers are not accepted.
  • Read Mode — Choose Blocks, Heading Outline, or Matching Blocks. Defaults to Blocks.
  • Block Query — Query used in Matching Blocks mode; the UI marks it as required for that mode.
  • Nearby Block Context — Context setting for Blocks and Matching Blocks modes, from 0 to 3; defaults to 1.
  • Block Limit — Limit for Blocks and Matching Blocks modes, from 1 to 20; defaults to 20.
  • Outline Limit — Limit for Heading Outline mode, from 1 to 100; defaults to 100.
  • Read Cursor — Opaque nextCursor from a previous response for continuing the read.

Output shape

A paginated result containing documentation block data or a heading outline, depending on Read Mode.

Matching Blocks uses Block Query. Responses may include a nextCursor for subsequent reads.

Links

Discussion