For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
DiscordPlatform
DocumentationIntegrationsAPI referenceSDKsChangelog
DocumentationIntegrationsAPI referenceSDKsChangelog
  • API Reference
      • POSTList customers
      • GETRetrieve a customer
      • PATCHUpdate a customer
      • DELDelete a customer
  • Reference
    • Filters API Reference
LogoLogo
DiscordPlatform
API ReferenceUsers

Retrieve a customer

GET
https://api.respan.ai/api/users/:customer_identifier/
GET
/api/users/:customer_identifier/
$curl -G https://api.respan.ai/api/users/customer_identifier/ \
>     -H "Authorization: Bearer sk_live_xxxxx" \
>     -d environment=prod
1{
2  "id": "user_123",
3  "name": "John Doe",
4  "email": "john@example.com",
5  "customer_identifier": "user_123",
6  "environment": "prod",
7  "total_budget": 1000,
8  "period_budget": 100,
9  "organization_name": "Acme Inc",
10  "total_period_usage": 45.67,
11  "period_start": "2025-12-01T00:00:00Z",
12  "period_end": null,
13  "budget_duration": "monthly",
14  "updated_at": "2025-12-29T10:30:00Z"
15}

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

Was this page helpful?
Previous

Update a customer

Next
Built with

Path parameters

customer_identifierstringRequired
Your unique identifier for this customer.

Headers

AuthorizationstringRequired

Bearer token. Use Bearer YOUR_API_KEY.

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.
Allowed values:
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.
Allowed values:
updated_atdatetime
Last update timestamp.

Errors

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