content and nested parent information for each document, and the response may be large.
API Overview
Query Parameters
The current list API does not support filtering by
alias or parent_id. When the alias is known, directly call Document Details; when building tree navigation, fetch all pages at once and group them on the client side using each item’s parent.id.
Request Examples
Response Structure
DocumentIndexSerializer and currently returns model fields and nested relationships; related API documents may also include api_method. Fields may be added in a backward-compatible manner, and clients should read them as needed. When children, parsed content language, and content hash are required, use the details API.
For public records associated with source documents, content_source provides the source document identifier, source content hash, requested language, translation update time, and the ready, stale, missing, missing_source, or ambiguous status; this field is null for other records. The content_hash when ready corresponds to the translation in that language. The body is still displayed according to the original rules, including language fallback when a translation is missing; clients that need to synchronize documents should check both the status and hash, and must not determine whether an update has been completed based only on whether the body is non-empty.
Usage Recommendations
- The response includes document bodies. When synchronizing in batches, use pagination and set a reasonable timeout; do not fetch the same page concurrently.
- The alias is the stable identifier of the public page URL; when the alias is known, directly request
/api/v1/documents/{alias}. - The current API cannot filter by parent on the server side; when building navigation, group by
parent.idon the client side.

