Outline Templates API
`Templates` represent reusable document templates that can be used as a starting point when creating new documents. Templates can be scoped to a specific collection or available workspace-wide.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/outline-templates-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Outline Templates API
description: '# Introduction
The Outline API is structured in an RPC style.'
version: 0.1.0
contact:
email: hello@getoutline.com
license:
name: BSD-3-Clause
url: https://github.com/outline/openapi/blob/main/LICENSE
servers:
- url: https://app.getoutline.com/api
description: Cloud hosted
- url: https://{domain}/api
description: Self-hosted on your own server
variables:
domain:
default: example.com
security:
- BearerAuth: []
- OAuth2:
- read
- write
tags:
- name: Templates
description: '`Templates` represent reusable document templates that can be used as a
starting point when creating new documents. Templates can be scoped to a
specific collection or available workspace-wide.'
paths:
/templates.create:
post:
tags:
- Templates
summary: Create a template
description: Create a new template that can be used as a starting point for new documents. Templates can optionally be scoped to a specific collection.
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: string
format: uuid
description: Optionally provide a specific UUID for the template.
title:
type: string
description: The title of the template.
minLength: 1
maxLength: 255
data:
type: object
description: The body of the template as a Prosemirror document.
icon:
type:
- string
- 'null'
description: An emoji to use as the template icon.
color:
type:
- string
- 'null'
description: The color of the template icon in hex format.
pattern: ^#[0-9A-Fa-f]{6}$
collectionId:
type: string
format: uuid
description: Identifier for the collection to which the template belongs.
required:
- title
- data
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/Template'
policies:
type: array
items:
$ref: '#/components/schemas/Policy'
'400':
$ref: '#/components/responses/Validation'
'401':
$ref: '#/components/responses/Unauthenticated'
'403':
$ref: '#/components/responses/Unauthorized'
'429':
$ref: '#/components/responses/RateLimited'
operationId: templatesCreate
/templates.list:
post:
tags:
- Templates
summary: List all templates
description: List all templates available to the current user. Optionally filter by collection. Templates not associated with a collection are workspace-wide.
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Pagination'
- $ref: '#/components/schemas/Sorting'
- type: object
properties:
collectionId:
type: string
format: uuid
description: Optionally filter to a specific collection
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Template'
policies:
type: array
items:
$ref: '#/components/schemas/Policy'
pagination:
$ref: '#/components/schemas/Pagination'
'401':
$ref: '#/components/responses/Unauthenticated'
'403':
$ref: '#/components/responses/Unauthorized'
'429':
$ref: '#/components/responses/RateLimited'
operationId: templatesList
/templates.info:
post:
tags:
- Templates
summary: Retrieve a template
description: Retrieve a template by its unique identifier.
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: Unique identifier for the template. Either the UUID or the urlId is acceptable.
required:
- id
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/Template'
policies:
type: array
items:
$ref: '#/components/schemas/Policy'
'400':
$ref: '#/components/responses/Validation'
'401':
$ref: '#/components/responses/Unauthenticated'
'403':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/RateLimited'
operationId: templatesInfo
/templates.update:
post:
tags:
- Templates
summary: Update a template
description: Update an existing template by its unique identifier.
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: Unique identifier for the template. Either the UUID or the urlId is acceptable.
title:
type: string
description: The title of the template.
data:
type: object
description: The body of the template as a Prosemirror document.
icon:
type:
- string
- 'null'
description: An emoji to use as the template icon.
color:
type:
- string
- 'null'
description: The color of the template icon in hex format.
pattern: ^#[0-9A-Fa-f]{6}$
fullWidth:
type: boolean
description: Whether the template should be displayed full width.
collectionId:
type:
- string
- 'null'
format: uuid
description: Identifier for the collection to which the template belongs. Set to null for a workspace-wide template.
required:
- id
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/Template'
policies:
type: array
items:
$ref: '#/components/schemas/Policy'
'400':
$ref: '#/components/responses/Validation'
'401':
$ref: '#/components/responses/Unauthenticated'
'403':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/RateLimited'
operationId: templatesUpdate
/templates.delete:
post:
tags:
- Templates
summary: Delete a template
description: Delete a template by its unique identifier. This will soft-delete the template, it can be restored later.
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: Unique identifier for the template. Either the UUID or the urlId is acceptable.
required:
- id
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
'400':
$ref: '#/components/responses/Validation'
'401':
$ref: '#/components/responses/Unauthenticated'
'403':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/RateLimited'
operationId: templatesDelete
/templates.restore:
post:
tags:
- Templates
summary: Restore a template
description: Restore a previously deleted template by its unique identifier.
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: Unique identifier for the template. Either the UUID or the urlId is acceptable.
required:
- id
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/Template'
policies:
type: array
items:
$ref: '#/components/schemas/Policy'
'400':
$ref: '#/components/responses/Validation'
'401':
$ref: '#/components/responses/Unauthenticated'
'403':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/RateLimited'
operationId: templatesRestore
/templates.duplicate:
post:
tags:
- Templates
summary: Duplicate a template
description: Create a copy of an existing template. Optionally override the title and target collection.
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: Unique identifier for the template to duplicate. Either the UUID or the urlId is acceptable.
title:
type: string
description: Override the title of the duplicated template.
collectionId:
type:
- string
- 'null'
format: uuid
description: Identifier for the collection to place the duplicated template in. If not provided, uses the original template's collection.
required:
- id
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/Template'
policies:
type: array
items:
$ref: '#/components/schemas/Policy'
'400':
$ref: '#/components/responses/Validation'
'401':
$ref: '#/components/responses/Unauthenticated'
'403':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/RateLimited'
operationId: templatesDuplicate
components:
schemas:
Pagination:
type: object
properties:
offset:
type: number
example: 0
limit:
type: number
example: 25
Ability:
description: A single permission granted by a policy
example: true
oneOf:
- type: array
items:
type: string
- type: boolean
Sorting:
type: object
properties:
sort:
type: string
example: updatedAt
direction:
type: string
example: DESC
enum:
- ASC
- DESC
UserRole:
type: string
enum:
- admin
- member
- viewer
- guest
Error:
type: object
properties:
ok:
type: boolean
example: false
error:
type: string
message:
type: string
status:
type: number
data:
type: object
Template:
type: object
properties:
id:
type: string
description: Unique identifier for the object.
readOnly: true
format: uuid
url:
type: string
description: A URL path to access the template.
readOnly: true
urlId:
type: string
description: A short unique identifier for the template used in URLs.
readOnly: true
title:
type: string
description: The title of the template.
data:
type: object
description: The body of the template as a Prosemirror document.
icon:
type:
- string
- 'null'
description: An emoji to use as the template icon.
color:
type:
- string
- 'null'
description: The color of the template icon in hex format.
fullWidth:
type: boolean
description: Whether the template should be displayed full width.
collectionId:
type:
- string
- 'null'
description: Identifier for the associated collection, if any.
format: uuid
createdAt:
type: string
description: The date and time that the template was created.
readOnly: true
format: date-time
createdBy:
$ref: '#/components/schemas/User'
updatedAt:
type: string
description: The date and time that the template was last changed.
readOnly: true
format: date-time
updatedBy:
$ref: '#/components/schemas/User'
deletedAt:
type:
- string
- 'null'
description: The date and time that the template was deleted.
readOnly: true
format: date-time
publishedAt:
type:
- string
- 'null'
description: The date and time that the template was published.
readOnly: true
format: date-time
User:
type: object
properties:
id:
type: string
description: Unique identifier for the object.
readOnly: true
format: uuid
name:
type: string
description: The name of this user, it is migrated from Slack or Google Workspace when the SSO connection is made but can be changed if necessary.
example: Jane Doe
avatarUrl:
type: string
format: uri
description: The URL for the image associated with this user, it will be displayed in the application UI and email notifications.
color:
type: string
description: A color representing the user, used in the UI for avatars without an image.
readOnly: true
email:
type: string
description: The email associated with this user, it is migrated from Slack or Google Workspace when the SSO connection is made but can be changed if necessary.
format: email
readOnly: true
role:
$ref: '#/components/schemas/UserRole'
isSuspended:
type: boolean
description: Whether this user has been suspended.
readOnly: true
lastActiveAt:
type:
- string
- 'null'
description: The last time this user made an API request, this value is updated at most every 5 minutes.
readOnly: true
format: date-time
timezone:
type:
- string
- 'null'
description: The timezone this user has registered.
createdAt:
type: string
description: The date and time that this user first signed in or was invited as a guest.
readOnly: true
format: date-time
updatedAt:
type: string
description: The date and time that this user was last updated.
readOnly: true
format: date-time
deletedAt:
type:
- string
- 'null'
description: The date and time that this user was deleted, if applicable.
readOnly: true
format: date-time
Policy:
type: object
properties:
id:
type: string
description: Unique identifier for the object this policy references.
format: uuid
readOnly: true
abilities:
type: object
description: The abilities that are allowed by this policy, if an array is returned then the individual ID's in the array represent the memberships that grant the ability.
additionalProperties:
$ref: '#/components/schemas/Ability'
example:
read: true
update: true
delete: false
responses:
RateLimited:
description: The request was rate limited.
headers:
Retry-After:
$ref: '#/components/headers/Retry-After'
RateLimit-Limit:
$ref: '#/components/headers/RateLimit-Limit'
RateLimit-Remaining:
$ref: '#/components/headers/RateLimit-Remaining'
RateLimit-Reset:
$ref: '#/components/headers/RateLimit-Reset'
content:
application/json:
schema:
type: object
properties:
ok:
type: boolean
example: false
error:
type: string
example: rate_limit_exceeded
status:
type: number
example: 429
Validation:
description: The request failed one or more validations.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
Unauthenticated:
description: The API key is missing or otherwise invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
Unauthorized:
description: The current API key is not authorized to perform this action.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
NotFound:
description: The specified resource was not found.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
headers:
RateLimit-Limit:
schema:
type: integer
description: The maximum requests available in the current duration.
Retry-After:
schema:
type: integer
description: Seconds in the future to retry the request, if rate limited.
RateLimit-Reset:
schema:
type: string
description: Timestamp in the future the duration will reset.
RateLimit-Remaining:
schema:
type: integer
description: How many requests are left in the current duration.
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
OAuth2:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://app.getoutline.com/oauth/authorize
tokenUrl: https://app.getoutline.com/oauth/token
refreshUrl: https://app.getoutline.com/oauth/token
scopes:
read: Read access
write: Write access