GET /wiki/rest/api/template/blueprint

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.

Servers

Query parameters

Name Type Required Description
limit Integer No

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

Default value: 25

spaceKey String No

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

expand[] Array No

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.
start Integer No

The starting index of the returned templates.

Default value: 0

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.