---
title: "List customers"
method: POST
path: "/api/users/list/"
tags: ["users"]
---

# List customers

`POST /api/users/list/`

Retrieve customers in your organization with analytics and budget fields. Available filter fields include `customer_identifier`, `name`, `email`, `number_of_requests`, `total_tokens`, `total_cost`, and `active_days`.

## Query parameters

- `page` integer
- `page_size` integer
- `sort_by` string
- `environment` 'prod' | 'test'

## Headers

- `Authorization` string, required

## Request body

- object
  - `filters` Filters — Filter criteria. See [Filters API Reference](/docs/apis/reference/filters-api-reference) for operator syntax.
    - `status` FilterValue — A filter condition with an operator and value.
      - `operator` '' | 'iexact' | 'lt' | 'lte' | 'gt' | 'gte' | 'contains' | 'icontains' | 'startswith' | 'endswith' | 'in' | 'isnull' | 'not' — Comparison operator. Empty string for exact match.
      - `value` unknown[], required — Value(s) to filter by.
        - unknown
    - `status_code` FilterValue — A filter condition with an operator and value.
      - `operator` '' | 'iexact' | 'lt' | 'lte' | 'gt' | 'gte' | 'contains' | 'icontains' | 'startswith' | 'endswith' | 'in' | 'isnull' | 'not' — Comparison operator. Empty string for exact match.
      - `value` unknown[], required — Value(s) to filter by.
        - unknown
    - `unique_id` FilterValue — A filter condition with an operator and value.
      - `operator` '' | 'iexact' | 'lt' | 'lte' | 'gt' | 'gte' | 'contains' | 'icontains' | 'startswith' | 'endswith' | 'in' | 'isnull' | 'not' — Comparison operator. Empty string for exact match.
      - `value` unknown[], required — Value(s) to filter by.
        - unknown
    - `customer_identifier` FilterValue — A filter condition with an operator and value.
      - `operator` '' | 'iexact' | 'lt' | 'lte' | 'gt' | 'gte' | 'contains' | 'icontains' | 'startswith' | 'endswith' | 'in' | 'isnull' | 'not' — Comparison operator. Empty string for exact match.
      - `value` unknown[], required — Value(s) to filter by.
        - unknown
    - `thread_identifier` FilterValue — A filter condition with an operator and value.
      - `operator` '' | 'iexact' | 'lt' | 'lte' | 'gt' | 'gte' | 'contains' | 'icontains' | 'startswith' | 'endswith' | 'in' | 'isnull' | 'not' — Comparison operator. Empty string for exact match.
      - `value` unknown[], required — Value(s) to filter by.
        - unknown
    - `custom_identifier` FilterValue — A filter condition with an operator and value.
      - `operator` '' | 'iexact' | 'lt' | 'lte' | 'gt' | 'gte' | 'contains' | 'icontains' | 'startswith' | 'endswith' | 'in' | 'isnull' | 'not' — Comparison operator. Empty string for exact match.
      - `value` unknown[], required — Value(s) to filter by.
        - unknown
    - `group_identifier` FilterValue — A filter condition with an operator and value.
      - `operator` '' | 'iexact' | 'lt' | 'lte' | 'gt' | 'gte' | 'contains' | 'icontains' | 'startswith' | 'endswith' | 'in' | 'isnull' | 'not' — Comparison operator. Empty string for exact match.
      - `value` unknown[], required — Value(s) to filter by.
        - unknown
    - `prompt_id` FilterValue — A filter condition with an operator and value.
      - `operator` '' | 'iexact' | 'lt' | 'lte' | 'gt' | 'gte' | 'contains' | 'icontains' | 'startswith' | 'endswith' | 'in' | 'isnull' | 'not' — Comparison operator. Empty string for exact match.
      - `value` unknown[], required — Value(s) to filter by.
        - unknown
    - `trace_unique_id` FilterValue — A filter condition with an operator and value.
      - `operator` '' | 'iexact' | 'lt' | 'lte' | 'gt' | 'gte' | 'contains' | 'icontains' | 'startswith' | 'endswith' | 'in' | 'isnull' | 'not' — Comparison operator. Empty string for exact match.
      - `value` unknown[], required — Value(s) to filter by.
        - unknown
    - `span_parent_id` FilterValue — A filter condition with an operator and value.
      - `operator` '' | 'iexact' | 'lt' | 'lte' | 'gt' | 'gte' | 'contains' | 'icontains' | 'startswith' | 'endswith' | 'in' | 'isnull' | 'not' — Comparison operator. Empty string for exact match.
      - `value` unknown[], required — Value(s) to filter by.
        - unknown
    - `is_root_span` FilterValue — A filter condition with an operator and value.
      - `operator` '' | 'iexact' | 'lt' | 'lte' | 'gt' | 'gte' | 'contains' | 'icontains' | 'startswith' | 'endswith' | 'in' | 'isnull' | 'not' — Comparison operator. Empty string for exact match.
      - `value` unknown[], required — Value(s) to filter by.
        - unknown
    - `span_workflow_name` FilterValue — A filter condition with an operator and value.
      - `operator` '' | 'iexact' | 'lt' | 'lte' | 'gt' | 'gte' | 'contains' | 'icontains' | 'startswith' | 'endswith' | 'in' | 'isnull' | 'not' — Comparison operator. Empty string for exact match.
      - `value` unknown[], required — Value(s) to filter by.
        - unknown
    - `span_name` FilterValue — A filter condition with an operator and value.
      - `operator` '' | 'iexact' | 'lt' | 'lte' | 'gt' | 'gte' | 'contains' | 'icontains' | 'startswith' | 'endswith' | 'in' | 'isnull' | 'not' — Comparison operator. Empty string for exact match.
      - `value` unknown[], required — Value(s) to filter by.
        - unknown
    - `model` FilterValue — A filter condition with an operator and value.
      - `operator` '' | 'iexact' | 'lt' | 'lte' | 'gt' | 'gte' | 'contains' | 'icontains' | 'startswith' | 'endswith' | 'in' | 'isnull' | 'not' — Comparison operator. Empty string for exact match.
      - `value` unknown[], required — Value(s) to filter by.
        - unknown
    - `log_type` FilterValue — A filter condition with an operator and value.
      - `operator` '' | 'iexact' | 'lt' | 'lte' | 'gt' | 'gte' | 'contains' | 'icontains' | 'startswith' | 'endswith' | 'in' | 'isnull' | 'not' — Comparison operator. Empty string for exact match.
      - `value` unknown[], required — Value(s) to filter by.
        - unknown
    - `stream` FilterValue — A filter condition with an operator and value.
      - `operator` '' | 'iexact' | 'lt' | 'lte' | 'gt' | 'gte' | 'contains' | 'icontains' | 'startswith' | 'endswith' | 'in' | 'isnull' | 'not' — Comparison operator. Empty string for exact match.
      - `value` unknown[], required — Value(s) to filter by.
        - unknown
    - `tools` FilterValue — A filter condition with an operator and value.
      - `operator` '' | 'iexact' | 'lt' | 'lte' | 'gt' | 'gte' | 'contains' | 'icontains' | 'startswith' | 'endswith' | 'in' | 'isnull' | 'not' — Comparison operator. Empty string for exact match.
      - `value` unknown[], required — Value(s) to filter by.
        - unknown
    - `cache_hit` FilterValue — A filter condition with an operator and value.
      - `operator` '' | 'iexact' | 'lt' | 'lte' | 'gt' | 'gte' | 'contains' | 'icontains' | 'startswith' | 'endswith' | 'in' | 'isnull' | 'not' — Comparison operator. Empty string for exact match.
      - `value` unknown[], required — Value(s) to filter by.
        - unknown
    - `cache_key` FilterValue — A filter condition with an operator and value.
      - `operator` '' | 'iexact' | 'lt' | 'lte' | 'gt' | 'gte' | 'contains' | 'icontains' | 'startswith' | 'endswith' | 'in' | 'isnull' | 'not' — Comparison operator. Empty string for exact match.
      - `value` unknown[], required — Value(s) to filter by.
        - unknown
    - `prompt_tokens` FilterValue — A filter condition with an operator and value.
      - `operator` '' | 'iexact' | 'lt' | 'lte' | 'gt' | 'gte' | 'contains' | 'icontains' | 'startswith' | 'endswith' | 'in' | 'isnull' | 'not' — Comparison operator. Empty string for exact match.
      - `value` unknown[], required — Value(s) to filter by.
        - unknown
    - `completion_tokens` FilterValue — A filter condition with an operator and value.
      - `operator` '' | 'iexact' | 'lt' | 'lte' | 'gt' | 'gte' | 'contains' | 'icontains' | 'startswith' | 'endswith' | 'in' | 'isnull' | 'not' — Comparison operator. Empty string for exact match.
      - `value` unknown[], required — Value(s) to filter by.
        - unknown
    - `total_tokens` FilterValue — A filter condition with an operator and value.
      - `operator` '' | 'iexact' | 'lt' | 'lte' | 'gt' | 'gte' | 'contains' | 'icontains' | 'startswith' | 'endswith' | 'in' | 'isnull' | 'not' — Comparison operator. Empty string for exact match.
      - `value` unknown[], required — Value(s) to filter by.
        - unknown
    - `cost` FilterValue — A filter condition with an operator and value.
      - `operator` '' | 'iexact' | 'lt' | 'lte' | 'gt' | 'gte' | 'contains' | 'icontains' | 'startswith' | 'endswith' | 'in' | 'isnull' | 'not' — Comparison operator. Empty string for exact match.
      - `value` unknown[], required — Value(s) to filter by.
        - unknown
    - `latency` FilterValue — A filter condition with an operator and value.
      - `operator` '' | 'iexact' | 'lt' | 'lte' | 'gt' | 'gte' | 'contains' | 'icontains' | 'startswith' | 'endswith' | 'in' | 'isnull' | 'not' — Comparison operator. Empty string for exact match.
      - `value` unknown[], required — Value(s) to filter by.
        - unknown
    - `metadata` FilterValue — A filter condition with an operator and value.
      - `operator` '' | 'iexact' | 'lt' | 'lte' | 'gt' | 'gte' | 'contains' | 'icontains' | 'startswith' | 'endswith' | 'in' | 'isnull' | 'not' — Comparison operator. Empty string for exact match.
      - `value` unknown[], required — Value(s) to filter by.
        - unknown
    - `messages` FilterValue — A filter condition with an operator and value.
      - `operator` '' | 'iexact' | 'lt' | 'lte' | 'gt' | 'gte' | 'contains' | 'icontains' | 'startswith' | 'endswith' | 'in' | 'isnull' | 'not' — Comparison operator. Empty string for exact match.
      - `value` unknown[], required — Value(s) to filter by.
        - unknown
    - `positive_feedback` FilterValue — A filter condition with an operator and value.
      - `operator` '' | 'iexact' | 'lt' | 'lte' | 'gt' | 'gte' | 'contains' | 'icontains' | 'startswith' | 'endswith' | 'in' | 'isnull' | 'not' — Comparison operator. Empty string for exact match.
      - `value` unknown[], required — Value(s) to filter by.
        - unknown
    - `evaluator_id` FilterValue — A filter condition with an operator and value.
      - `operator` '' | 'iexact' | 'lt' | 'lte' | 'gt' | 'gte' | 'contains' | 'icontains' | 'startswith' | 'endswith' | 'in' | 'isnull' | 'not' — Comparison operator. Empty string for exact match.
      - `value` unknown[], required — Value(s) to filter by.
        - unknown

## Response `200`

Paginated list of customers.

- UsersListCustomersResponse200
  - `count` integer, required — Total number of matching customers.
  - `next` string, nullable — Next page URL.
  - `previous` string, nullable — Previous page URL.
  - `results` ApiUsersListPostResponsesContentApplicationJsonSchemaResultsItems[], required — Customers for the current page.
    - `id` string — Synthetic customer ID used by list responses.
    - `customer_identifier` string — Your unique identifier for the customer.
    - `unique_organization_id` string — Organization unique ID.
    - `environment` 'prod' | 'test' — Customer environment.
    - `name` string, nullable — Customer display name.
    - `email` string, nullable — Customer email address.
    - `first_seen` string, date-time — When the customer was first observed.
    - `last_active_timeframe` string, date-time — Most recent activity within the selected timeframe.
    - `active_days` integer — Number of active days in the selected timeframe.
    - `number_of_requests` integer — Total requests made by this customer.
    - `total_requests` integer — Alias of `number_of_requests` for backward compatibility.
    - `total_tokens` integer — Total tokens used by this customer.
    - `tokens` integer — Alias of `total_tokens` for backward compatibility.
    - `total_cost` number, double — Total cost in USD.
    - `cost` number, double — Alias of `total_cost` for backward compatibility.
    - `average_latency` number, double, nullable — Average latency in seconds.
    - `average_ttft` number, double, nullable — Average time to first token in seconds.
    - `average_monthly_cost` number, double — Estimated average monthly cost based on observed activity.
    - `period_budget` number, double, nullable — Current period budget in USD, when configured.
    - `budget_duration` 'daily' | 'weekly' | 'monthly' — Budget renewal period.
    - `total_budget` number, double, nullable — Lifetime spending budget in USD, when configured.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized - Missing/invalid authentication
- `413` — The query exceeded a memory or execution-time resource limit.
- `429` — Rate Limited
- `500` — Internal Server Error

---

[API](https://skmtc.net/keywordsai/apis/api-reference.md) · [All operations](https://skmtc.net/keywordsai/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/keywordsai/api-reference/revisions/4e064cf81dae/schema)