---
title: "Download full data export"
method: GET
path: "/v1/account/export"
tags: ["account"]
---

# Download full data export

`GET /v1/account/export`

## Request

- Base URL: `https://api.brixsignage.com`
- URL: `https://api.brixsignage.com/v1/account/export`
- Auth: HTTP bearer

Returns a data export of the workspace as one downloadable file: the workspace record, its members, nine content tables and the last 365 days of activity-log events. Credentials are never included. Because the file holds every member's personal data, it requires permission to export billing data (`billing.export`) for the whole workspace. Permission to edit billing is not enough. Brix does not email or store the export. For every table and the complete activity log, use the export manifest and its parts.

**Notes.**
- No `{ data }` envelope: the body is the export file (`Content-Disposition: attachment`).
- Credentials are never exported: their columns are kept with `null` or a `[secret; not exported]` / `[encrypted; not exported]` marker.
- `generatedBy.kind` is `user` even when an API key made the export (and then `userId` is absent).
- The complete export (every table, the whole audit log) is `GET /v1/account/export/manifest` and its parts.

## Response `200`

Success.

- object
  - `schemaVersion` 1, required
  - `generatedAt` string, required: ISO-8601 timestamp (UTC).
  - `generatedBy` object, required: Always `user`; `userId` is absent for an API key.
    - `kind` 'user', required
    - `userId` string
  - `workspace` object, required: The workspace record (every column; the Screen Lock PIN hash replaced by `kioskHasGlobalPin` inside `prefs`).
  - `people` object[], required
    - `id` string, required
    - `name` string, required
    - `email` string, required
    - `status` string, required
    - `lastLoginAt` string, nullable, required: ISO-8601 timestamp (UTC).
    - `createdAt` string, required: ISO-8601 timestamp (UTC).
  - `content` object, required: Nine content tables, one object per row (all columns).
    - `screens` object[], required
    - `mediaAssets` object[], required
    - `playlists` object[], required
    - `schedules` object[], required
    - `layouts` object[], required
    - `creatives` object[], required
    - `appInstances` object[], required
    - `dataSources` object[], required
    - `banners` object[], required
  - `auditEvents` object[], required: The last 365 days only.
  - `limits` object, required
    - `auditEvents` string, required
    - `completeness` string, required

## Other responses

- `401`: Missing, expired or revoked bearer token.
- `403`: You do not hold the permission for the whole workspace (a grant at one location is not enough).
- `5XX`: Server error. The body carries a `requestId` to quote to support.

---

[API](https://skmtc.dev/brixsignage/apis/brix-api.md) · [All operations](https://skmtc.dev/brixsignage/apis/brix-api/llms.txt) · [OpenAPI document](https://skmtc.dev/brixsignage/apis/brix-api/revisions/02fd3665dc7d?raw)