DEdefaulr
Pins

List pins

Changed on

List the pinned documents for a collection, or for the home screen when no collectionId is provided.

post/pins.list

Request

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

The collection to list pins for. Omit to list home screen pins.

Example request

{
  "limit": 25
}

Response

OK

Example response

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

Changes