OUouterport
Documents

Get all documents

Changed on

Retrieves a paginated list of all visible documents in the system.

get/api/v0/documents

Request

Query parameters

limitinteger

Maximum number of documents to return per page.

offsetinteger

Number of documents to skip.

cursorstring nullable

The pagination.next_cursor of the previous page: the page starts at the first document after that page's last. Reading on by cursor never skips a document when documents are added or deleted between reads; it repeats one only when that page's last document was deleted and another shares its creation time to the microsecond. total still counts every matching document and offset is 0. Cannot be combined with a nonzero offset.

folder_idstring uuid nullable

The ID of the folder to filter documents by.

tag_namestring nullable

The name of the tag to filter documents by.

owner_idstring uuid nullable

The ID of the owner to filter documents by.

knowledge_base_idstring uuid nullable

The ID of the knowledge base to filter documents by.

Response

Successful Response

Changes

  • 7f81908bcdfeRevision changes
    • info

      added the new optional query request parameter cursor

    • info

      added the optional property / to the response with the status

  • fcd15f6d35b4Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status