---
title: "Export a collection"
method: POST
path: "/collections.export"
tags: ["Collections"]
---

# Export a collection

`POST /collections.export`

Triggers a bulk export of the collection in markdown format and their attachments. If documents are nested then they will be nested in folders inside the zip file. The endpoint returns a `FileOperation` that can be queried to track the progress of the export and get the url for the final file.

## Request body

- object
  - `format` 'outline-markdown' | 'json' | 'html'
  - `id` string, uuid, required

## Response `200`

OK

- object
  - `data` object
    - `fileOperation` FileOperation
      - `id` string, uuid — Unique identifier for the object.
      - `type` 'import' | 'export' — The type of file operation.
      - `state` 'creating' | 'uploading' | 'complete' | 'error' | 'expired' — The state of the file operation.
      - `collection` object, nullable
        - `id` string, uuid — Unique identifier for the object.
        - `name` string — The name of the collection.
        - `description` string — A description of the collection, may contain markdown formatting
        - `sort` object — The sort of documents in the collection. Note that not all API responses respect this and it is left as a frontend concern to implement.
          - `field` string
          - `direction` 'asc' | 'desc'
        - `index` string — The position of the collection in the sidebar
        - `color` string — A color representing the collection, this is used to help make collections more identifiable in the UI. It should be in HEX format including the #
        - `icon` string — A string that represents an icon in the outline-icons package
        - `permission` 'read' | 'read_write'
        - `createdAt` string, date-time — The date and time that this object was created
        - `updatedAt` string, date-time — The date and time that this object was last changed
        - `deletedAt` string, date-time, nullable — The date and time that this object was deleted
      - `user` User
        - `id` string, uuid — Unique identifier for the object.
        - `name` string — The name of this user, it is migrated from Slack or Google Workspace when the SSO connection is made but can be changed if neccessary.
        - `avatarUrl` string, uri — The URL for the image associated with this user, it will be displayed in the application UI and email notifications.
        - `email` string, email — The email associated with this user, it is migrated from Slack or Google Workspace when the SSO connection is made but can be changed if neccessary.
        - `role` 'admin' | 'member' | 'viewer' | 'guest'
        - `isSuspended` boolean — Whether this user has been suspended.
        - `lastActiveAt` string, date-time — The last time this user made an API request, this value is updated at most every 5 minutes.
        - `createdAt` string, date-time — The date and time that this user first signed in or was invited as a guest.
      - `size` number — The size of the resulting file in bytes
      - `createdAt` string, date-time — The date and time that this object was created

## Other responses

- `401` — The API key is missing or otherwise invalid.
- `403` — The current API key is not authorized to perform this action.
- `404` — The specified resource was not found.
- `429` — The request was rate limited.

## Changes

- **2024-10-18** `fdf2ec9c9df4` — 1 info
  - added the non-success response with the status `429`
- **2024-07-06** `7b33b538cd7d` — 9 info
  - added the optional property `data` to the response with the `401` status
  - added the optional property `data` to the response with the `403` status
  - added the optional property `data` to the response with the `404` status
  - added the optional property `message` to the response with the `401` status
  - …5 more

[Change history](https://skmtc.dev/defaulr/apis/outline-api/changes/collections.export/post.md)

---

[API](https://skmtc.dev/defaulr/apis/outline-api.md) · [All operations](https://skmtc.dev/defaulr/apis/outline-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/defaulr/outline-api/revisions/fdf2ec9c9df4/schema)