DEdefaulr
Shares

Retrieve a share object

Changed on

Retrieve the details of a share link by its unique identifier or by the associated document ID. Shares allow documents to be accessed publicly or by specific users.

post/shares.info

Request

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

idstring

Unique identifier for the share. Either the UUID or the share slug is acceptable.

documentIdstring uuid

Unique identifier for a document. One of id or documentId must be provided.

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
      }
    }
  ]
}

Changes