---
title: "Export an account, Type or organization as Markdown with YAML frontmatter"
method: GET
path: "/api/preview/export"
tags: ["import"]
---

# Export an account, Type or organization as Markdown with YAML frontmatter

`GET /api/preview/export`

## Request

- Base URL: `https://symbol.chat` (the document declares no server; this is the origin it was published from)
- URL: `https://symbol.chat/api/preview/export`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `__Secure-next-auth.session-token`
  - OAuth 2
    - Authorization code: `https://mcp.symbol.chat/authorize`
    - Token URL: `https://mcp.symbol.chat/token`

## Query parameters

- `scope` 'account' | 'type' | 'org', required: `account` (your personal workspace), `type` (one Type), or `org` (an organization you administer).
- `type_id` string: The Type to export, for scope `type`.
- `workspace_id` string: The organization to export, for scope `org`.
- `cursor` string: `next_cursor` from the previous page.

## Response `200`

Successful response

- object: One page of an export: Markdown files with YAML frontmatter.
  - `files` object[], required
    - `content` string, required
    - `path` string, required
  - `format_version` integer, required
  - `manifest` object, nullable, required: Present on the first page only: the export's Types with their field schemas.
    - `exported_at` string, required
    - `format_version` integer, required
    - `references` 'current': `current` when the files write each reference field value at its target's current address (exports taken after issue #2509). An import repoints a retired Type slug in a reference value only for files without it.
    - `scope` 'account' | 'type' | 'org', required
    - `types` object[], required
    - `workspace` object, required
      - `id` string, nullable, required: UUID v4 string
      - `name` string, required
  - `next_cursor` string, nullable, required
  - `scope` 'account' | 'type' | 'org', required

## Changes

- **2026-10-19** `5778844d1f9e`: 1 info
  - added the optional property `manifest/anyOf[subschema #1]/references` to the response with the `200` status
- **2026-09-30** `6a95af57f0f6`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/symbol/apis/symbol-api/changes/api/preview/export/get.md)

---

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