List documents

List documents you can access through any membership — owned and shared with you. your_role on each result tells you whether you can write before you try. Never includes content; use get_document.

post/api/v1/list_documents

Request

  • Base URL: https://offprint.io
  • URL: https://offprint.io/api/v1/list_documents
  • Auth: HTTP bearer

Request body

querystring

Filter to documents whose title contains this text (case-insensitive).

visibility'public' | 'private'

Filter to public or private documents.

role'owner' | 'editor' | 'commenter' | 'viewer'

Filter to documents where you have this role.

owned_by_meboolean

Only documents you own.

projectstring

Filter to one project (name or id). Names resolve against your own projects.

limitinteger

Maximum results to return (default 20, at most 50).

cursorstring

The next_cursor from a previous call, to fetch the next page.

Response

Success.

next_cursorstring nullable required

Pass as cursor to get the next page; null on the last page.

Changes

No recorded changes to this operation across all 1 revision of this API.