DEdefaulr
Shares

List all shares

Changed on

List all share links in the workspace.

post/shares.list

Request

  • Base URL
    https://app.getoutline.com/api
  • URL
    https://app.getoutline.com/api/shares.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
sortstring
direction'ASC' | 'DESC'
querystring

Filter to shared documents matching a search query

Example request

{
  "limit": 25,
  "sort": "updatedAt",
  "direction": "DESC"
}

Response

OK

Example response

{
  "data": [
    {
      "documentTitle": "React best practices",
      "includeChildDocuments": true,
      "allowSubscriptions": true,
      "createdBy": {
        "name": "Jane Doe"
      }
    }
  ],
  "policies": [
    {
      "abilities": {
        "read": true,
        "update": true,
        "delete": false
      }
    }
  ],
  "pagination": {
    "limit": 25
  }
}

Changes

  • 9a99ee93e11dRevision changes
    • info

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

  • 33bab0a8aefcRevision changes
    • breaking

      the response property // became nullable for the status

    • breaking

      the // response's property type changed from object to no type for status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • info

      the response optional property // became read-only for the status

    • info

      added to the // response property allOf list for the response status