DEdefaulr
Pins

Retrieve a pin

Changed on

Retrieve the pin for a document, either within a collection or on the home screen.

post/pins.info

Request

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

documentIdstring uuid required

Identifier for the pinned document.

collectionIdstring uuid nullable

Identifier for the collection. Omit to retrieve the home screen pin.

Response

OK

Example response

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

Changes