DEdefaulr
Templates

List all templates

Changed on

List all templates available to the current user. Optionally filter by collection. Templates not associated with a collection are workspace-wide.

post/templates.list

Request

  • Base URL
    https://app.getoutline.com/api
  • URL
    https://app.getoutline.com/api/templates.list
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://app.getoutline.com/oauth/authorize
      Token URL: https://app.getoutline.com/oauth/token scopes: read, write

Request body

offsetnumber
limitnumber
sortstring
direction'ASC' | 'DESC'
collectionIdstring uuid

Optionally filter to a specific collection

querystring

Search query to filter templates by title

Example request

{
  "limit": 25,
  "sort": "updatedAt",
  "direction": "DESC"
}

Response

OK

Example response

{
  "data": [
    {
      "createdBy": {
        "name": "Jane Doe"
      },
      "updatedBy": {
        "name": "Jane Doe"
      }
    }
  ],
  "policies": [
    {
      "abilities": {
        "read": true,
        "update": true,
        "delete": false
      }
    }
  ],
  "pagination": {
    "limit": 25
  }
}

Changes

  • 5ddf01ffba84Revision changes
    • info

      added the optional property // to the response with the status

    • info

      response property data/items/url deprecated

  • 9a99ee93e11dRevision changes
    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status