---
title: "List Counts"
method: GET
path: "/organization/usage/user-counts"
tags: ["usage"]
---

# List Counts

`GET /organization/usage/user-counts`

One page of the caller's own organization's per-member consumption, as of ``date``.

``date`` is the exclusive end of the window being reported on. Omitting it
reports on now, which is what makes the reply cover the window in progress.

## Query parameters

- `policy_id` string, uuid, nullable
- `resource_kind` 'investigation' — A category of product activity metered and governed on its own. Two activities are different kinds when their accounting or entitlement behavior differs, not merely because a user would name them differently.
- `date` string, date-time, nullable — Exclusive end of the window to report on, which selects what was live at that instant. Absent means the window containing now.
- `query` string, nullable — Matched against the member's name and email.
- `page` integer
- `page_size` integer
- `sort_by` 'count' — Allowlisted sort fields; every value must name a ``UserUsageCount`` field.
- `sort_order` 'asc' | 'desc'

## Response `200`

Successful Response

- ListUserUsageCountsResponse — Response for ``GET /organization/usage/user-counts``.
  - `counts` UserUsageCount[], required
    - `policy_id` string, uuid, required
    - `target_id` string, uuid, required
    - `resource_kind` 'investigation', required — A category of product activity metered and governed on its own. Two activities are different kinds when their accounting or entitlement behavior differs, not merely because a user would name them differently.
    - `count` integer, required
    - `limit` integer, nullable — Absent when the policy imposes no limit.
    - `scope` 'user'
    - `user` UsageCountUser — The member a user-scope count is attributed to, as a reader displays them.
      - `name` string, nullable, required — Absent when the member has no recorded name.
      - `email` string, required
      - `role` union, required
        - 'platform_admin' — Platform-level roles for Traversal employees. These roles have no organization_id and apply across all organizations. Only grant to Traversal internal employees (@traversal.com). Attributes: ADMIN: Full access to all organizations and platform settings. Can view/edit all data, manage users, configure integrations.
        - 'org_admin' | 'org_member' | 'org_setup_user' — Organization-level roles for customer users. These roles require an organization_id and only apply within that organization. Users can have different roles in different organizations. Attributes: ADMIN: Full access within the organization. Can manage users, configure integrations, view/edit all sessions, manage billing. MEMBER: Standard user access within the organization. Can create and view their own sessions, view team sessions, use integrations. SETUP_USER: Limited setup access. Can configure integrations, but cannot view sessions or start investigations.
      - `identity_kind` 'member' | 'unattributed', required — How a user-scoped usage target should be presented.
  - `next_page` integer, nullable, required — None on the last page.
  - `prev_page` integer, nullable, required — None on the first page.
  - `total_entries` integer, required — Rows matching the filters across every page.

## Other responses

- `422` — Validation Error

## Changes

> 57 revisions in range; 9 not diffed.

- **2026-09-17** `4a4435773444` — 2 info
  - added `subschema #3` to the `counts/items/user/anyOf[subschema #1: UsageCountUser]/role` response property `anyOf` list for the response status `200`
  - added the required property `counts/items/user/anyOf[subschema #1: UsageCountUser]/identity_kind` to the response with the `200` status
- **2026-09-10** `47dcc19b4add` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/traversal/apis/fastapi/changes/organization/usage/user-counts/get.md)

---

[API](https://skmtc.dev/traversal/apis/fastapi.md) · [All operations](https://skmtc.dev/traversal/apis/fastapi/llms.txt) · [OpenAPI document](https://skmtc.dev/traversal/apis/fastapi/revisions/c3bd9dec6c16?raw)