---
updatedAt: 2026-04-21T21:33:48.000Z
agentTools:
  projectIndex: https://docs.oneschema.co/llms.txt
---

# Export as Excel file

Create an Excel file with the contents of the sheet.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Sheets",
    "version": "1",
    "contact": {
      "name": "OneSchema Support",
      "email": "support@oneschema.co"
    },
    "license": {
      "name": "proprietary",
      "url": "https://www.oneschema.co/terms-and-conditions"
    },
    "termsOfService": "https://www.oneschema.co/terms-and-conditions",
    "description": "An API for managing OneSchema Sheets."
  },
  "tags": [
    {
      "name": "Sheets",
      "description": "Sheets operations"
    }
  ],
  "paths": {
    "/v1/sheets/{sheet_id}/export-file/excel": {
      "post": {
        "operationId": "export-file-excel",
        "summary": "Export as Excel file",
        "description": "Create an Excel file with the contents of the sheet.",
        "parameters": [
          {
            "name": "sheet_id",
            "in": "path",
            "required": true,
            "description": "The id of the sheet.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "row_filter",
            "in": "query",
            "required": false,
            "description": "Which rows should be included in the export.",
            "schema": {
              "type": "string",
              "enum": [
                "all",
                "clean",
                "errors"
              ],
              "default": "all"
            },
            "explode": false
          },
          {
            "name": "include_unmapped",
            "in": "query",
            "required": false,
            "description": "If unmapped columns should be included in the exported file.",
            "schema": {
              "type": "boolean",
              "default": false
            },
            "explode": false
          },
          {
            "name": "embed_id",
            "in": "query",
            "required": true,
            "description": "[importer only] The id of the embed which contains the sheet.",
            "schema": {
              "type": "integer",
              "format": "int32"
            },
            "explode": false
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/download-url-response"
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/empty-response"
                }
              }
            }
          }
        },
        "tags": [
          "Sheets"
        ]
      }
    }
  },
  "security": [
    {
      "ApiKeyAuth": []
    }
  ],
  "components": {
    "schemas": {
      "download-url-response": {
        "type": "object",
        "properties": {
          "download_url": {
            "type": "string",
            "examples": [
              "https://s3.amazonaws.com/XXX"
            ]
          }
        }
      },
      "empty-response": {
        "type": "object",
        "properties": {}
      }
    },
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-KEY"
      }
    }
  },
  "servers": [
    {
      "url": "https://api.oneschema.co",
      "description": "Production server (hosted in the US)",
      "variables": {}
    },
    {
      "url": "https://api.eu.oneschema.co",
      "description": "Production server (hosted in the EU)",
      "variables": {}
    },
    {
      "url": "https://api.ca.oneschema.co",
      "description": "Production server (hosted in Canada)",
      "variables": {}
    },
    {
      "url": "https://api.au.oneschema.co",
      "description": "Production server (hosted in Australia)",
      "variables": {}
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```