DEdefaulr
Views

List all views

Changed on

List all users that have viewed a document and the overall view count.

post/views.list

Request

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

The document ID to retrieve views for

includeSuspendedboolean

Whether to include views from suspended users

Example request

{
  "limit": 25
}

Response

OK

Example response

{
  "data": [
    {
      "count": 22,
      "user": {
        "name": "Jane Doe"
      }
    }
  ],
  "pagination": {
    "limit": 25
  }
}

Changes

  • 4852380ff4f4Revision changes
    • breaking

      added subschema #2 to the request body allOf list

    • breaking

      the request's body type changed from object to no type

    • warning

      removed the request property

    • warning

      removed the request property

    • info

      added the optional property to the response with the status

  • 9a99ee93e11dRevision changes
    • info

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