DEdefaulr
Documents

Retrieve a document

Changed on

Retrieve a document by its UUID, urlId, or shareId. At least one of these parameters must be provided.

post/documents.info

Request

  • Base URL
    https://app.getoutline.com/api
  • URL
    https://app.getoutline.com/api/documents.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 document. Either the UUID or the urlId is acceptable.

shareIdstring uuid

Unique identifier for a document share, a shareId may be used in place of a document UUID

Response

OK

Example response

{
  "data": {
    "title": "Welcome to Acme Inc",
    "icon": "🎉",
    "text": "…",
    "urlId": "hDYep1TPAM",
    "createdBy": {
      "name": "Jane Doe"
    },
    "updatedBy": {
      "name": "Jane Doe"
    },
    "deletedBy": {
      "name": "Jane Doe"
    }
  },
  "policies": [
    {
      "abilities": {
        "read": true,
        "update": true,
        "delete": false
      }
    }
  ]
}

Changes

  • 5ddf01ffba84Revision changes
    • info

      added the optional property / to the response with the status

    • info

      response property data/url deprecated

  • a75820943fbbRevision changes
    • info

      added the optional property / to the response with the status