メインコンテンツへ移動

次に使うツールを探す

API/リファレンス/ドキュメントを一覧表示
GET/api/v1/documents

ドキュメントを一覧表示

認証済みアカウントで利用できるドキュメントを一覧表示します。

認証

API キー

スコープ

documents:read

契約

API v1

リクエスト

curl -X GET 'https://api.maxscanner.app/api/v1/documents' \
  -H 'Authorization: Bearer $MAXSCANNER_API_KEY' \
  -H 'Content-Type: application/json'

リクエスト本文

GET /api/v1/documents?limit=20

レスポンス

{ "documents": [], "nextCursor": null }

実装上の注意

  • ドキュメントはアカウント単位で管理されます。
  • 大量のコレクションにはカーソルによるページングを使ってください。

このエンドポイントを試す

エンドポイントをアプリに組み込む前に、API プレイグラウンドで認証して安全にテストしましょう。

プレイグラウンドを開く →