> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kair.is/llms.txt
> Use this file to discover all available pages before exploring further.

# Request a workspace data export archive

> Request a workspace data export archive. Requires workspace ownership or platform admin. Returns 202; the download link is emailed when ready (within ~1 hour).



## OpenAPI

````yaml /openapi.json post /workspaces/{workspace_id}/export
openapi: 3.0.0
info:
  title: Braid
  version: '1.0'
servers:
  - url: http://localhost:8001/api
security: []
tags:
  - name: Admin
  - name: ApiKey
  - name: Auth
  - name: Calendar
  - name: Capture
  - name: Concerns
  - name: Dashboard
  - name: DataRequests
  - name: Device
  - name: Feedback
  - name: Graph
  - name: Health
  - name: Job
  - name: OAuth
  - name: Organisation
  - name: Realtime
  - name: Search
  - name: Session
  - name: Workshop
  - name: Workspace
paths:
  /workspaces/{workspace_id}/export:
    post:
      tags:
        - DataRequests
      summary: Request a workspace data export archive
      description: >-
        Request a workspace data export archive. Requires workspace ownership or
        platform admin. Returns 202; the download link is emailed when ready
        (within ~1 hour).
      parameters:
        - name: workspace_id
          schema:
            type: string
          in: path
          required: true
          deprecated: false
          explode: true
      requestBody:
        content:
          application/json; charset=utf-8:
            schema:
              $ref: '#/components/schemas/ExportRequestBody'
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json; charset=utf-8:
              schema: {}
        '201':
          description: ''
          content:
            application/json; charset=utf-8:
              schema: {}
        '202':
          description: ''
        '204':
          description: ''
        '400':
          description: ''
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: ''
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: ''
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: ''
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: ''
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '410':
          description: ''
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '413':
          description: ''
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '415':
          description: ''
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: ''
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: ''
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: ''
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '502':
          description: ''
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: ''
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    ExportRequestBody:
      type: object
      title: ExportRequestBody
      required:
        - format
      properties:
        format:
          $ref: '#/components/schemas/ExportFormat'
    ErrorResponse:
      type: object
      title: ErrorResponse
      required:
        - success
        - message
      properties:
        success:
          type: boolean
        message:
          type: string
    ExportFormat:
      type: string
      enum:
        - json
        - csv
        - markdown

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.