Get blueprint templates
GET {{baseUrl}}/api/template/blueprint?spaceKey=<string>&start=0&limit=25&expand=<string>&expand=<string>
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: Permission to access the Confluence site ('Can use' global permission).
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
spaceKey | string | The key of the space to be queried for templates. If the spaceKey | |
| is not specified, global blueprint templates will be returned. | |||
start | number | The starting index of the returned templates. | |
limit | number | The maximum number of templates to return per page. | |
| Note, this may be restricted by fixed system limits. | |||
expand | string | A multi-value parameter indicating which properties of the template | |
| to expand. |
-
bodyreturns the content of the template in storage format. | |expand| string | | A multi-value parameter indicating which properties of the template to expand. -
bodyreturns the content of the template in storage format. |
RESPONSES
status: OK
{"results":[{"templateId":"velit aute fug","originalTemplate":{"pluginKey":"id adipisicing ex ea amet","moduleKey":"elit occaecat exercitation"},"referencingBlueprint":"fug","name":"do sit esse officia dolore","description":"commodo et eu","labels":[{"prefix":"nisi cupidatat in proident","name":"deserunt magna ut eu","id":"dolor in","label":"nostrud culpa enim"},{"prefix":"sint qui labore","name":"Ut qui exercitation dolore","id":"non dolor aute","label":"dolor quis magna ex"}],"templateType":"officia","_expandable":{"body":"pariatur Ut deserunt"},"_links":{},"body":{"value":"nulla aliqua culpa anim sunt","representation":"anonymous_export_view","_expandable":{"content":"ut est pariatur"},"embeddedContent":[{"entityId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"entity":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"entityId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"entity":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}],"webresource":{"keys":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"contexts":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"uris":{"all":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"css":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"js":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"tags":{"all":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"css":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"data":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"js":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"superbatch":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}}},{"templateId":"voluptate mollit in","originalTemplate":{"pluginKey":"Excepteur laborum","moduleKey":"ea nulla"},"referencingBlueprint":"ipsum magna velit adipisicing est","name":"in velit pariatur","description":"ipsum qui et","labels":[{"prefix":"incididunt non laborum sit","name":"id tempor","id":"mollit","label":"deserunt exercitation tempor nulla"},{"prefix":"nostrud dolor","name":"eiusmod in ad","id":"cupidatat labore in","label":"do deserunt amet"}],"templateType":"aute","_expandable":{"body":"labore deserunt"},"_links":{},"body":{"value":"aute qui","representation":"editor2","_expandable":{"content":"occaecat ea voluptate nostrud"},"embeddedContent":[{"entityId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"entity":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"entityId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"entity":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}],"webresource":{"keys":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"contexts":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"uris":{"all":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"css":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"js":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"tags":{"all":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"css":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"data":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"js":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"superbatch":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}}}],"start":-43882824,"limit":59508609,"size":-8662482,"_links":{}}