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_identifier
Your unique identifier for this customer.
Query parameters
environment
Specify environment if you are not using the default. Options: prod, test.
Response
Successful response for Retrieve user
id
customer_identifier
unique_organization_id
email
name
environment
organization
period_budget
budget_duration
total_period_usage
period_start
period_end
total_budget
total_usage
total_requests
total_prompt_tokens
total_completion_tokens
total_tokens
total_cache_hits
average_latency
average_ttft
average_monthly_cost
top_models
last_active
created_at
updated_at
metadata
markup_percentage
is_test
blurred
organization_key
Errors
401
Unauthorized Error