outline icon

outline

Interact with outline API

Actions107

Views → Views List

AI-generated

Summary

List views for a document

Inputs

  • documentId (required) — The document ID to retrieve views for
  • includeSuspended — Whether to include views from suspended users
  • requestOptions — Request options for batching and throttling requests
  • allowUnauthorizedCerts — Whether to accept the response even if SSL certificate validation is not possible
  • proxy — HTTP proxy to use. If authentication is required it can be defined as follow: http://username:password@myproxy:3128
  • timeout — Time in ms to wait for the server to send response headers (and start the response body) before aborting the request

Output shape

The API response containing the list of views for the specified document.

Return shape is not explicitly declared in properties or source; described as the API's views listing response.

Examples

Example 1: Retrieve all views for document X, including suspended users

Set documentId to the target document ID, enable includeSuspended, leave other options at defaults.

Links

Discussion