DEdefaulr
Comments

Retrieve a comment

Changed on

Retrieve a comment

post/comments.info

Request

  • Base URL
    https://app.getoutline.com/api
  • URL
    https://app.getoutline.com/api/comments.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 uuid required
includeAnchorTextboolean

Include the document text that the comment is anchored to, if any, in the response.

Response

OK

Example response

{
  "data": {
    "createdBy": {
      "name": "Jane Doe"
    },
    "resolvedBy": {
      "name": "Jane Doe",
      "invitedBy": {
        "name": "Jane Doe"
      }
    }
  },
  "policies": [
    {
      "abilities": {
        "read": true,
        "update": true,
        "delete": false
      }
    }
  ]
}

Changes

  • 9a99ee93e11dRevision changes
    • info

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

    • info

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

  • 304cd065561bRevision changes
    • breaking

      the response property // became nullable for the status

    • warning

      removed the optional property / from the response with the status

    • info

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

    • info

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

    • info

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

    • info

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

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status