DEdefaulr
Stars

List all stars

Changed on

List all starred documents for the authenticated user. Stars allow users to bookmark important documents for quick access in the sidebar.

post/stars.list

Request

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

Example request

{
  "limit": 25
}

Response

OK

Example response

{
  "data": {
    "documents": [
      {
        "title": "Welcome to Acme Inc",
        "icon": "🎉",
        "text": "…",
        "urlId": "hDYep1TPAM",
        "createdBy": {
          "name": "Jane Doe"
        },
        "updatedBy": {
          "name": "Jane Doe"
        },
        "deletedBy": {
          "name": "Jane Doe"
        }
      }
    ]
  },
  "pagination": {
    "limit": 25
  },
  "policies": [
    {
      "abilities": {
        "read": true,
        "update": true,
        "delete": false
      }
    }
  ]
}

Changes

  • 5ddf01ffba84Revision changes
    • info

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

    • info

      response property data/documents/items/url deprecated

  • a75820943fbbRevision changes
    • info

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