Retrieve user

Retrieves detailed information about a specific customer, including current budget usage. ## Authentication <Note> Public API: use an API key. - `Authorization: Bearer YOUR_API_KEY` (public API) </Note> ## Path params - `customer_identifier` *string* **required**: Your unique identifier for this customer. ## Query params You can add these params to the **URL params**. - `environment` *string*: Specify environment if you are not using the default. Options: `prod`, `test`. ## Request example ```python Python url = "https://api.respan.ai/api/users/user_123/" headers = {"Authorization": "Bearer YOUR_API_KEY"} resp = requests.get(url, headers=headers) print(resp.json()) ``` ```bash cURL curl "https://api.respan.ai/api/users/user_123/" \ -H "Authorization: Bearer YOUR_API_KEY" ``` ## Response ```json { "id": 12345, "customer_identifier": "user_123", "unique_organization_id": "8264a3f4-40c7-476a-97d1-96908127ea21", "email": "john@example.com", "name": "John Doe", "environment": "prod", "organization": 456, "period_budget": 100.0, "budget_duration": "monthly", "total_period_usage": 45.67, "period_start": "2025-12-01T00:00:00Z", "period_end": null, "total_budget": null, "total_usage": 523.45, "total_requests": 15420, "total_prompt_tokens": 125000, "total_completion_tokens": 45000, "total_tokens": 170000, "total_cache_hits": 234, "average_latency": 1.23, "average_ttft": 0.45, "average_monthly_cost": 67.89, "top_models": {}, "last_active": "2025-12-29T10:30:00Z", "created_at": "2025-10-15T08:00:00Z", "updated_at": "2025-12-29T10:30:00Z", "metadata": null, "markup_percentage": 0.0, "is_test": false, "blurred": null, "organization_key": null } ```

Authentication

AuthorizationBearer
API key authentication. Get your API key from https://platform.respan.ai/platform/api-keys

Path parameters

customer_identifierstringRequired
Your unique identifier for this customer.

Query parameters

environmentstringOptionalDefaults to prod

Specify environment if you are not using the default. Options: prod, test.

Response

Successful response for Retrieve user
idinteger
customer_identifierstring
unique_organization_idstring
emailstring
namestring
environmentstring
organizationinteger
period_budgetdouble
budget_durationstring
total_period_usagedouble
period_startstring
period_endstring
total_budgetstring
total_usagedouble
total_requestsinteger
total_prompt_tokensinteger
total_completion_tokensinteger
total_tokensinteger
total_cache_hitsinteger
average_latencydouble
average_ttftdouble
average_monthly_costdouble
top_modelsobject
last_activestring
created_atstring
updated_atstring
metadatastring
markup_percentagedouble
is_testboolean
blurredstring
organization_keystring

Errors

401
Unauthorized Error