Outline · Example Payload

Accessrequestsinfo

AccessRequests

Accessrequestsinfo 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": "accessRequestsInfo",
  "path": "/accessRequests.info",
  "method": "POST",
  "summary": "Retrieve an access request",
  "tags": [
    "AccessRequests"
  ],
  "requestSchema": {
    "type": "object",
    "properties": {
      "id": {
        "type": "string",
        "format": "uuid",
        "description": "Unique identifier for the access request."
      },
      "documentId": {
        "type": "string",
        "format": "uuid",
        "description": "Identifier for the document to find a pending request for the current user."
      }
    }
  }
}