Change request content
Manage the actual content changes associated with a change request.
Retrieve or update the pages and files tied to an open change request. This lets you preview alterations and merge them when ready.
Returns the current revision snapshot of the change request, including the full page tree structure and metadata. Use this to inspect the overall state of the change request's content, such as the list of pages and their hierarchy, without fetching each page individually. For page content (body text), use the individual page endpoints.
A unique entity identifier
^[a-zA-Z0-9_-]+$A unique entity identifier
^[a-zA-Z0-9_-]+$If false is passed, "git" mutable metadata will not returned. Passing false can optimize performances of the lookup.
trueIf false is passed, content will not be computed
trueOK
OK
Applies an ordered array of content changes (up to 50) to the change request atomically, creating a single new revision. Changes are applied sequentially; if any single change is invalid the entire batch is rejected and no revision is created. Use this to create, update, move, or delete pages within a change request before merging to live. This is the primary way to programmatically author content in a change request.
A unique entity identifier
^[a-zA-Z0-9_-]+$A unique entity identifier
^[a-zA-Z0-9_-]+$The change request has been updated
Type of Object, always equals to "change-request"
Unique identifier for the change request
Incremental identifier of the change request
Subject of the change request
ID of the space in which the change request was created.
ID of the active revision in the change request.
ID of the initial revision in the space from which the change request was created.
ID of the latest revision when updating from main space content.
When merged, ID of the revision resulting from the merge.
Count of opened comments on the change request.
If true, the change request is not up-to-date with latest changes in the main content.
The change request could not be found.
Returns the full flat list of all pages in the change request's current draft revision, including page groups. Does not include page body content — use the individual page endpoint to fetch content. Use this to get an overview of the draft's page structure before reading or modifying specific pages.
A unique entity identifier
^[a-zA-Z0-9_-]+$A unique entity identifier
^[a-zA-Z0-9_-]+$If false is passed, "git" mutable metadata will not returned. Passing false can optimize performances of the lookup.
trueIf false is passed, content will not be computed
trueOK
OK
Returns a paginated list of files (images and other attachments) stored in the change request's current revision. Use this to inspect uploaded assets within a draft before merging. For files in the live published space, use the space content files endpoint.
A unique entity identifier
^[a-zA-Z0-9_-]+$A unique entity identifier
^[a-zA-Z0-9_-]+$Identifier of the page results to fetch.
The number of results per page
If false is passed, "git" mutable metadata will not returned. Passing false can optimize performances of the lookup.
trueIf false is passed, content will not be computed
trueOK
Total count of objects in the list
OK
Retrieves metadata for a single file (image or attachment) stored in the change request's current revision. Use this to get the download URL or details of a specific asset referenced by a page in the change request.
A unique entity identifier
^[a-zA-Z0-9_-]+$A unique entity identifier
^[a-zA-Z0-9_-]+$A unique entity identifier
^[a-zA-Z0-9_-]+$If false is passed, "git" mutable metadata will not returned. Passing false can optimize performances of the lookup.
trueIf false is passed, content will not be computed
trueOK
OK
Returns a paginated list of content locations (pages and inline positions) within the change request that link to or embed the specified file. Use this to find all usages of an asset before renaming or removing it.
A unique entity identifier
^[a-zA-Z0-9_-]+$A unique entity identifier
^[a-zA-Z0-9_-]+$A unique entity identifier
^[a-zA-Z0-9_-]+$Identifier of the page results to fetch.
The number of results per page
OK
Total count of objects in the list
OK
Retrieves a specific page from a change request's draft content, including its title, metadata, and body document. Use the documentFormat parameter to control the format of the returned document (e.g., markdown). This reflects the draft state of the page, not the live published version — use the space content page endpoint for live content.
A unique entity identifier
^[a-zA-Z0-9_-]+$A unique entity identifier
^[a-zA-Z0-9_-]+$A unique entity identifier
^[a-zA-Z0-9_-]+$Output format for the content.
Controls how content references are formatted in markdown output. Ignored unless format=markdown.
relative: Format page references as relative links from the current page. Other references might not be handled.stable: Format content references as stable idempotent refs containing their identifiers.
relativePossible values: Controls whether the document should be evaluated.
- When set to
true, the entire document will be evaluated. - When set to
deterministic-only, only expressions that depend exclusively on deterministic inputs will be evaluated.
falseControls whether the document should be deferenced (eference to other content will be resolved and expanded).
- When set to
true, the entire document will be deferenced - When set to
reusable-contents, only reusable contents will be deferenced.
falseIf false is passed, "git" mutable metadata will not returned. Passing false can optimize performances of the lookup.
trueIf false is passed, content will not be computed
trueOK
OK
Returns all outbound content references from a specific page within the change request, including their status (valid, broken) and usage context. Use this to audit link health on a draft page before merging. Also returns aggregate stats about broken vs healthy references on the page.
A unique entity identifier
^[a-zA-Z0-9_-]+$A unique entity identifier
^[a-zA-Z0-9_-]+$A unique entity identifier
^[a-zA-Z0-9_-]+$Identifier of the page results to fetch.
The number of results per page
OK
Total count of objects in the list
OK
Returns a paginated list of content locations within the change request that contain links pointing to the specified page. Use this to check what pages would be affected by renaming or removing a page before applying the change.
A unique entity identifier
^[a-zA-Z0-9_-]+$A unique entity identifier
^[a-zA-Z0-9_-]+$A unique entity identifier
^[a-zA-Z0-9_-]+$Identifier of the page results to fetch.
The number of results per page
OK
Total count of objects in the list
OK
Returns the structural navigation links for a specific page within a change request, such as its parent page, previous sibling, and next sibling in the page tree. Use this to understand a page's position within the content hierarchy of the draft.
A unique entity identifier
^[a-zA-Z0-9_-]+$A unique entity identifier
^[a-zA-Z0-9_-]+$A unique entity identifier
^[a-zA-Z0-9_-]+$OK
OK
Retrieves a specific reusable content block (a shared snippet that can be embedded across multiple pages) from the change request's draft revision. Use this to inspect the current draft state of a shared content block before merging.
A unique entity identifier
^[a-zA-Z0-9_-]+$A unique entity identifier
^[a-zA-Z0-9_-]+$A unique entity identifier
^[a-zA-Z0-9_-]+$If false is passed, "git" mutable metadata will not returned. Passing false can optimize performances of the lookup.
trueIf false is passed, content will not be computed
trueOK
OK
Returns the semantic diff between the change request's current content and the base revision it branched from. Each item describes a logical change such as a page added, removed, or modified. Use this to summarise what a change request changes before merging or reviewing. The default limit is 10 — increase it if the change request is large.
A unique entity identifier
^[a-zA-Z0-9_-]+$A unique entity identifier
^[a-zA-Z0-9_-]+$Limit the number of changes returned
10OK
How many changes were omitted because above the result limit
The change request could not be found.
Retrieves a specific page from a change request's draft content using its URL path (e.g., "getting-started/installation") rather than its ID. Use this when you know the path of a page but not its ID. Returns either a document page or a page group, depending on the path. Supports the same format and evaluation options as the ID-based endpoint.
A unique entity identifier
^[a-zA-Z0-9_-]+$A unique entity identifier
^[a-zA-Z0-9_-]+$The path of the page in the revision.
Output format for the content.
Controls how content references are formatted in markdown output. Ignored unless format=markdown.
relative: Format page references as relative links from the current page. Other references might not be handled.stable: Format content references as stable idempotent refs containing their identifiers.
relativePossible values: Controls whether the document should be evaluated.
- When set to
true, the entire document will be evaluated. - When set to
deterministic-only, only expressions that depend exclusively on deterministic inputs will be evaluated.
falseControls whether the document should be deferenced (eference to other content will be resolved and expanded).
- When set to
true, the entire document will be deferenced - When set to
reusable-contents, only reusable contents will be deferenced.
falseIf false is passed, "git" mutable metadata will not returned. Passing false can optimize performances of the lookup.
trueIf false is passed, content will not be computed
trueOK
OK
Last updated
Was this helpful?