Outline · Example Payload

Viewslist

Views

Viewslist is an example object payload from Outline, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdpathmethodsummarytagsrequestSchema

Example Payload

Raw ↑ 
{
  "operationId": "viewsList",
  "path": "/views.list",
  "method": "POST",
  "summary": "List all views",
  "tags": [
    "Views"
  ],
  "requestSchema": {
    "type": "object",
    "properties": {
      "documentId": {
        "type": "string",
        "format": "uuid",
        "description": "The document ID to retrieve views for"
      },
      "includeSuspended": {
        "type": "boolean",
        "description": "Whether to include views from suspended users",
        "default": false
      }
    },
    "required": [
      "documentId"
    ]
  }
}