---
title: "Account Facets"
method: GET
path: "/accounts/facets"
tags: ["accounts"]
---

# Account Facets

`GET /accounts/facets`

## Request

- Base URL: `https://dev.whispa.net` (the document declares no server; this is the origin it was published from)
- URL: `https://dev.whispa.net/accounts/facets`
- Auth: one of:
  - OAuth 2
    - Password
    - Token URL: `auth/bearer/login`
  - API key in cookie `access_token`

Filter vocabulary for the accounts table (admin only): the provider
status values actually present with their counts, and the outstanding /
arrears bounds. Computed over the whole visible working set, so narrowing
the filter never removes options from the menu.

## Query parameters

- `demo_market` 'au' | 'us', nullable

## Response `200`

Successful Response

- AccountFacetsRead: Filter vocabulary for the accounts table, computed over the working set. ``status`` is a free-text provider snapshot, so the values on offer can only come from the data — there is no enum to render from. Counts are unfiltered totals for the active provider, which is what makes them useful for deciding what to filter to next.
  - `statuses` AccountStatusFacet[]
    - `value` string, required
    - `count` integer, required
  - `campaigns` AccountCampaignFacet[]
    - `id` string, uuid, required
    - `name` string, required
    - `status` string, required
    - `count` integer, required
  - `balance_min` number, nullable
  - `balance_max` number, nullable
  - `arrears_min` number, nullable
  - `arrears_max` number, nullable
  - `total` integer
  - `timezone_unknown` integer
  - `timezone_manual` integer

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/whispa/apis/whispa-api.md) - [All operations](https://skmtc.dev/whispa/apis/whispa-api/llms.txt) - [OpenAPI document](https://skmtc.dev/whispa/apis/whispa-api/revisions/12c2e4aca43c?raw)