DEdefaulr
Documents

List all draft documents

Changed on

This method will list all draft documents belonging to the current user.

post/documents.drafts

Request

  • Base URL
    https://app.getoutline.com/api
  • URL
    https://app.getoutline.com/api/documents.drafts
  • 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

A collection to search within

dateFilter'day' | 'week' | 'month' | 'year'

Any documents that have not been updated within the specified period will be filtered out

Example request

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

Response

OK

Example response

{
  "data": [
    {
      "title": "Welcome to Acme Inc",
      "icon": "🎉",
      "text": "…",
      "urlId": "hDYep1TPAM",
      "createdBy": {
        "name": "Jane Doe"
      },
      "updatedBy": {
        "name": "Jane Doe"
      },
      "deletedBy": {
        "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

  • a75820943fbbRevision changes
    • info

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