Export a setup sheet as an Excel file for a given sheet type, optionally filtered.
The response is an .xlsx file download. Supported setup sheet types include CREATE and UPDATE variants for
accounts, meters, buildings, cost centers, vendors, users, chargebacks, readings, benchmarks, and more.
Use GET /api/v3/setup/filter to discover available filter fields for the given type.
Request Headers
| Header | Value | Required | Description |
|---|---|---|---|
| ECI-ApiKey | string | Yes | Your API key. See Authentication. |
| Content-Type | application/json | Yes | All requests must specify JSON content type. |
Query Parameters
| Name | Description | Type | Required |
|---|---|---|---|
| type | The setup sheet type (e.g. CREATE_AccountsAndMeters, UPDATE_BuildingsAndOrganizations) | string | Optional |
| filter | Optional filter string to limit the exported data | string | Optional |
Responses
200
OK
The request succeeded and the response body contains the requested data.
Response Body Parameters
Type: string (binary)
Example Response
"string"