McMain icon

McMain

Interact with McMain API

Document → Get List

AI-generated

Summary

Retrieve a list of documents from the McMain API.

Inputs

  • returnAll — Whether to return all results or only up to a given limit
  • limit — Maximum number of results to return (used when returnAll is false)
  • requestOptions — Advanced request configuration including batching, SSL verification, proxy, and timeout

Output shape

a list of Document objects

Response contains an array of document records; errors are wrapped in a standard error envelope.

Examples

Example 1: Get the first 20 documents.

returnAll=false, limit=20

Example 2: Retrieve all documents.

returnAll=true

Example 3: Use batching with default batch size.

requestOptions.batch.batchSize=50, requestOptions.batchInterval=1000

Discussion