---
title: "Converting Excel To Json - DreamFactory Documentation"
source: "https://wiki.dreamfactory.com/Converting_Excel_To_Json"
canonical_url: "https://wiki.dreamfactory.com/Converting_Excel_To_Json"
converted_at: "2026-04-05T06:18:22.075Z"
format: "markdown"
converted_by: "html-to-md-ai"
---
[]()
	
	
	
	# Converting Excel To Json

	
		From DreamFactory Wiki
		
		
		
		
		[Jump to navigation](#mw-head)
		[Jump to search](#searchInput)
		

## Contents

- [1 Converting Excel to a JSON Response](#Converting_Excel_to_a_JSON_Response)

- [1.1 Creating an Excel Connector Service](#Creating_an_Excel_Connector_Service)

- [1.2 Using the Excel API](#Using_the_Excel_API)

- [1.3 See also](#See_also)

# Converting Excel to a JSON Response

DreamFactory's Excel connector is capable of turning an entire Excel workbook or specific worksheet into a JSON response (CSV files are also supported). Workbooks can be retrieved from any DreamFactory supported file-system (AWS S3, SFTP, and Azure Blob Storage, among others), or as in the example we will run through below, uploaded directly to the server's local file system. Access is controlled just like any other connector with role-based access control and API keys.

## Creating an Excel Connector Service

To create an Excel connector, log in to your DreamFactory instance using an administrator account and select the **API Generation & Connections** tab. Set your API Type to **File**, and then click the purple plus button to establish a new connection:

[![](/images/f/f6/File-api-creation.png)](/File:File-api-creation.png)  [](/File:File-api-creation.png)file api creation
Navigate to the **Excel** option in the available service types:

[![](/images/7/7f/Excel-api-selection.png)](/File:Excel-api-selection.png)  [](/File:Excel-api-selection.png)excel api selection
Next, provide a name, label and description for your Excel connector service:

[![](/images/8/85/Excel-service-info.png)](/File:Excel-service-info.png)  [](/File:Excel-service-info.png)excel service info
In the configuration section, you'll need to set the file storage service. If you have already setup an AWS S3 API or other file service, then that service will be available to you. For this example, we will use the local file storage service, and we will put our Excel file in `/opt/dreamfactory/storage/app` which means we will set the container path as `/` (the 'root' of where DreamFactory will look for locally stored files).

[![](/images/3/39/Excel-service-configuration.png)](/File:Excel-service-configuration.png)  [](/File:Excel-service-configuration.png)excel service configuration
The root location for local file storage is `/opt/dreamfactory/storage/app`. If you store an Excel file(s) here, your Storage Container Path will be `/`. If you create a folder in here, e.g. `/opt/dreamfactory/storage/app/my-folder` then your Storage Container Path will be `/my-folder/`.

## Using the Excel API

Once configured, you will be able to access the API endpoint documentation via the API Docs tab. Here we have an example call to our workbook `financial-sample.xlsx`:

[![](/images/7/78/Excel-api-documentation.png)](/File:Excel-api-documentation.png)  [](/File:Excel-api-documentation.png)excel api documentation
After configuring your Role and generating an API Key, you can interact with the Excel service. The below is a `GET` call to `/api/v2/<excelServiceName>/_spreadsheet/<excelFilename>`:

[![](/images/5/57/Excel-api-with-postman.png)](/File:Excel-api-with-postman.png)  [](/File:Excel-api-with-postman.png)excel api with postman
When creating a role for your Excel connector, you will also need to provide service access to the relevant file storage service, in addition to the Excel service. For local file storage this will be the default "files" service.

## See also

- [Creating an AWS S3 REST API](/Creating_Aws_S3_Rest_Api)

- [Creating an SFTP REST API](/Creating_Sftp_Rest_Api)

- [File System APIs](/File)

Retrieved from "[https://wiki.dreamfactory.com/index.php?title=Converting_Excel_To_Json&oldid=841](https://wiki.dreamfactory.com/index.php?title=Converting_Excel_To_Json&oldid=841)"
		[Categories](/Special:Categories): - [API](/Category:API)
- [Converting](/Category:Converting)
- [Excel](/Category:Excel)