API ReferenceUsers

Retrieve a customer

Retrieve a customer by customer_identifier. This endpoint returns the editable customer profile and current budget usage fields.

Authentication

AuthorizationBearer

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, OpenAI or Azure OpenAI provider credentials go in Settings -> Providers or the request body credential_override field, not in this auth field.

Path parameters

customer_identifierstringRequired
Your unique identifier for this customer.

Query parameters

environmentenumOptional
Optional environment filter. If omitted, the backend uses the environment implied by your auth context when applicable.
Allowed values:

Response

Customer details.
idstring
Customer identifier used by the detail serializer.
namestring or null
Customer display name.
emailstring or null
Customer email address.
customer_identifierstring
Your unique identifier for the customer.
environmentenum
Customer environment.
total_budgetdouble or null
Lifetime spending budget in USD.
period_budgetdouble or null
Current period budget in USD.
organization_namestring or null
Owning organization name.
total_period_usagedouble
Usage in the current budget period in USD.
period_startdatetime
Start of the current budget period.
period_enddatetime or null
End of the current budget period.
budget_durationenum
Budget renewal period.
updated_atdatetime
Last update timestamp.

Errors

401
Unauthorized Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error