DEdefaulr
Subscriptions

List subscriptions

Changed on

List the authenticated user's subscriptions for a given document or collection.

post/subscriptions.list

Request

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

The type of event that is subscribed to.

documentIdstring uuid

Filter to subscriptions for this document. Provide exactly one of documentId or collectionId.

collectionIdstring uuid

Filter to subscriptions for this collection. Provide exactly one of documentId or collectionId.

Example request

{
  "limit": 25
}

Response

OK

Example response

{
  "data": [
    {
      "event": "documents"
    }
  ],
  "pagination": {
    "limit": 25
  },
  "policies": [
    {
      "abilities": {
        "read": true,
        "update": true,
        "delete": false
      }
    }
  ]
}

Changes