DEdefaulr
Subscriptions

Retrieve a subscription

Changed on

Retrieve the authenticated user's subscription for a specific document or collection, if one exists.

post/subscriptions.info

Request

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

event'documents' required

The type of event that is subscribed to.

documentIdstring uuid

The subscribed document. Provide exactly one of documentId or collectionId.

collectionIdstring uuid

The subscribed collection. Provide exactly one of documentId or collectionId.

Response

OK

Example response

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

Changes