---
title: "Start an Item export job"
method: POST
path: "/api/exports"
tags: ["Exports"]
---

# Start an Item export job

`POST /api/exports`

## Request

- Base URL: `https://keep.md`
- URL: `https://keep.md/api/exports`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `keep.session_token`

Start an Item export job.

## Headers

- `Keep-API-Version` string

## Request body

- object
  - `format` 'csv' | 'json' | 'markdown-zip', required
  - `scope` union, required
    - object
      - `type` 'all', required
    - object
      - `type` 'tag', required
      - `tagId` string, required
    - object
      - `type` 'collection', required
      - `collectionId` string, required
    - object
      - `type` 'status', required
      - `status` 'stashed' | 'archived', required
  - `includeContent` boolean
  - `omitNotes` boolean
  - `dateFrom` integer
  - `dateTo` integer

## Response `200`

Queued export job

- object
  - `job` ExportJob, required
    - `id` string, required
    - `status` 'queued' | 'processing' | 'completed' | 'failed' | 'expired', required
    - `format` 'csv' | 'json' | 'markdown-zip', required
    - `scope` union, required
      - object
        - `type` 'all', required
      - object
        - `type` 'tag', required
        - `tagId` string, required
      - object
        - `type` 'collection', required
        - `collectionId` string, required
      - object
        - `type` 'status', required
        - `status` 'stashed' | 'archived', required
    - `includeContent` boolean, required
    - `omitNotes` boolean, required
    - `dateFrom` integer
    - `dateTo` integer
    - `itemCount` integer
    - `fileSize` integer
    - `error` string
    - `createdAt` integer, required
    - `startedAt` integer
    - `completedAt` integer
    - `expiresAt` integer

## Other responses

- `400`: Invalid request
- `401`: Authentication required
- `403`: The credential lacks access or the plan does not include the feature
- `409`: The request conflicts with the current resource state
- `429`: Request or plan limit reached
- `500`: Export could not be queued

---

[API](https://skmtc.dev/keep/apis/keep-api.md) · [All operations](https://skmtc.dev/keep/apis/keep-api/llms.txt) · [OpenAPI document](https://skmtc.dev/keep/apis/keep-api/revisions/a338a455bd0f?raw)