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, 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.

OR
AuthorizationBearer

Use a dashboard JWT only for dashboard-authenticated endpoints. Respan API-key endpoints use the respanApiKey auth field instead.

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.
idstringOptional
Customer identifier used by the detail serializer.
namestring or nullOptional
Customer display name.
emailstring or nullOptional
Customer email address.
customer_identifierstringOptional
Your unique identifier for the customer.
environmentenumOptional
Customer environment.
total_budgetdouble or nullOptional
Lifetime spending budget in USD.
period_budgetdouble or nullOptional
Current period budget in USD.
organization_namestring or nullOptional
Owning organization name.
total_period_usagedoubleOptional
Usage in the current budget period in USD.
period_startdatetimeOptional
Start of the current budget period.
period_enddatetime or nullOptional
End of the current budget period.
budget_durationenumOptional
Budget renewal period.
updated_atdatetimeOptional
Last update timestamp.

Errors

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