---
title: "Get data inventory"
method: GET
path: "/v1/account/data-inventory"
tags: ["account"]
---

# Get data inventory

`GET /v1/account/data-inventory`

## Request

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

Returns, for every category of data Brix holds about the workspace, what it is, whether it identifies a person, how long it is kept, whether it is included in a data export, and whether it is deleted when the account is closed. Pass `?counts=1` to include a row count for each category.

## Query parameters

- `counts` '1'

## Response `200`

Success.

- object
  - `data` object, required
    - `generatedAt` string, required: ISO-8601 timestamp (UTC).
    - `counted` boolean, required
    - `categories` object[], required
      - `id` string, required
      - `label` string, required
      - `what` string, required
      - `personal` string, required
      - `retention` string, required
      - `rows` integer, nullable, required
      - `tables` object[], required
        - `table` string, required
        - `rows` integer, nullable, required
        - `inExport` boolean, required
        - `exportNote` string, nullable, required
        - `erasedOnClose` boolean, required
        - `retainedNote` string, nullable, required
        - `strippedFields` string[], required
    - `residency` object, nullable, required: Where the workspace's data is stored. `database`, `media` and `backups` are internal store names.
      - `region` string, required
      - `label` string, required
      - `database` string, required
      - `media` string, required
      - `backups` string, required
    - `notes` 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)