Sign in

v3

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

Retrieve User

Consolidated single/detail view for customer users.

Serves BOTH:

  • Public API: /api/users/<customer_identifier>/ (URL path lookup)
  • Dashboard: /clickhouse/customer-users/<id>/?customer_identifier=xxx (query param lookup)

Retrieves customer user from PostgreSQL (not ClickHouse) because:

  1. Point retrieval is weak in ClickHouse
  2. Update operations require PostgreSQL
  3. All aggregation data is already returned in the list view

This view returns editable fields + real-time usage from Redis. Rate limited to protect against expensive point queries.

Uses SuperAdminMixin for queryset routing + object-level ownership. No manual org injection needed - SuperAdminMixin handles patch() automatically.

get/api/users/{customer_identifier}/

Path parameters

customer_identifierstring required

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

idstring required
namestring nullable
emailstring nullable
customer_identifierstring nullable
total_budgetnumber double nullable
period_budgetnumber double nullable
organization_namestring required
total_period_usagenumber double
period_startstring date-time
period_endstring date-time nullable
budget_durationstring
updated_atstring date-time