account

Download full data export

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.
get/v1/account/export

Request

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

Response

Success.

schemaVersion1 required
generatedAtstring required

ISO-8601 timestamp (UTC).

workspaceobject required

The workspace record (every column; the Screen Lock PIN hash replaced by kioskHasGlobalPin inside prefs).

auditEventsobject[] required

The last 365 days only.

Changes

No recorded changes to this operation across all 1 revision of this API.