v3

latestOpenAPI 3.1.02026-07-311,4541,5202.3 MB
creditTransactions

List Credit Transactions

GET /api/credit-transactions/list/ POST /api/credit-transactions/list/ (POST-for-Filtering) List credit transactions with optional filtering

This is the primary endpoint for listing transactions. Supports both GET (simple list) and POST (filtered list) operations.

Permissions: - Regular users: Can view their own org's transactions - Superadmin: Can view all transactions (with org filter via query params)

Query params (superadmin only): - org: Organization UUID to filter by

NOTE: CLICKHOUSE-ONLY STRATEGY - Queries ClickHouse directly instead of PostgreSQL

get/api/credit-transactions/list/

Query parameters

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

Headers

Authorizationstring required

Use your Respan API key for Respan API authentication. Enter only the Respan API key value; clients send Authorization: Bearer <RESPAN_API_KEY>. For /api/responses, provider credentials such as Perplexity, OpenAI, or Azure OpenAI go in Settings -> Providers or respan_params.credential_override in the request body, not in this authentication field.

Response

countinteger required
nextstring uri nullable
previousstring uri nullable
total_countinteger
current_filtersFilterParamDictPydantic

Pydantic model for FilterParamDict. A dictionary that maps metric names to their filter parameters.

Each key is a metric name (str), and each value can be:

  • A single MetricFilterParamPydantic (one condition)
  • A List[MetricFilterParamPydantic] (multiple conditions for same metric)
  • A FilterBundlePydantic (nested filter bundle with connector)

Note: Uses extra="allow" for dynamic metric name fields. The pydantic_extra annotation tells Pydantic what types to expect for extra fields, and generates typed additionalProperties in JSON Schema.

filters_dataPaginatedCreditTransactionListListFiltersData