outline icon

outline

Interact with outline API

Actions107

Documents → Documents Users

AI-generated

Summary

Filter documents by document ID and optional user name or user ID.

Inputs

  • id (required) — Unique identifier for the document. Either the UUID or the urlId is acceptable.
  • query — If set, will filter the results by user name.
  • userId — If set, will filter the results to a specific user.
  • 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 before aborting the request
  • requestOptions — Configuration for request options, including batching settings (batchSize, batchInterval).

Output shape

Filtered document data from the Outline API matching the specified criteria.

The operation sends the specified parameters as request body to the Outline API endpoint for listing/ filtering documents. Optional parameters (query, userId) refine the result set. SSL and proxy settings affect request handling. Batch throttling is configurable via requestOptions.

Links

Discussion