FileOperations

List all file operations

Changed on

List all file operations for the current workspace, filtered by type (import or export).

post/fileOperations.list

Request

  • Base URL
    https://app.getoutline.com/api
  • URL
    https://app.getoutline.com/api/fileOperations.list
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://app.getoutline.com/oauth/authorize
      Token URL: https://app.getoutline.com/oauth/token scopes: read, write

Request body

offsetnumber
limitnumber
sortstring
direction'ASC' | 'DESC'
type'export' | 'import' required

The type of fileOperation

Example request

{
  "limit": 25,
  "sort": "updatedAt",
  "direction": "DESC",
  "type": "export"
}

Response

OK

Example response

{
  "data": [
    {
      "type": "export",
      "format": "outline-markdown",
      "state": "complete",
      "size": "2048",
      "user": {
        "name": "Jane Doe"
      }
    }
  ],
  "pagination": {
    "limit": 25
  }
}

Changes

    • info

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

    • breaking

      the response property /// became nullable for 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

    • info

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