Get doc blocks

Retrieve a doc's content body as an ordered list of blocks, together with the doc's current version.

Each block has a block_ref that Edit doc content (POST /v1/docs/:doc_id/content/edits) operations address it by, except refs starting with module:, which are display-only. Blocks with editable: false are Dovetail modules (such as reference cards, reels, files and video) or blocks containing or inside one; they cannot be replaced, deleted or formatted, but blocks can be inserted before or after a module (not inside it).

text is plain text without formatting, and a container's (list, quote, table, toggle) text repeats the text of the blocks inside it, one line per block. The doc's title is not part of its body.

Every block is returned by default. To page through a long doc, pass max_chars and then each response's content_pagination.next_offset as offset until has_more is false.

Required scope: insight:read

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique identifier of the doc.

Query Params
integer | null
≥ 0

Index of the first block to return — a block index, unlike get_doc_content's offset, which is a character offset. Pass content_pagination.next_offset from a previous response to get the next blocks. Defaults to 0.

integer
≥ 1

Maximum combined length of the returned blocks' text fields only — not the size of the response as a whole, which also carries each block's other fields. Whole blocks are returned, and always at least one. Omit to return every block from offset.

Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json