v1

latestOpenAPI 3.0.12026-07-13130168404.3 KB
Template

Get blueprint templates

Returns all templates provided by blueprints. Use this method to retrieve all global blueprint templates or all blueprint templates in a space.

Note, all global blueprints are inherited by each space. Space blueprints can be customised without affecting the global blueprints.

Permissions required: 'View' permission for the space to view blueprints for the space and permission to access the Confluence site ('Can use' global permission) to view global blueprints.

get/wiki/rest/api/template/blueprint

Query parameters

spaceKeystring

The key of the space to be queried for templates. If the spaceKey is not specified, global blueprint templates will be returned.

startinteger

The starting index of the returned templates.

limitinteger

The maximum number of templates to return per page. Note, this may be restricted by fixed system limits.

expandstring[]

A multi-value parameter indicating which properties of the template to expand.

  • body or body.storage returns the content of the template in storage format.

Response

Returned if the requested templates are returned.

startinteger required
limitinteger required
sizeinteger required
_linksGenericLinks required