KEkeywordsai
Users

Get a user

Changed on

Returns the user's editable profile and current budget usage.

get/api/users/{customer_identifier}/

Request

  • Base URL
    https://api.respan.ai
  • URL
    https://api.respan.ai/api/users/{customer_identifier}/
  • Auth
    • HTTP bearer
    • or HTTP bearer

Path parameters

customer_identifierstring required

Your unique identifier for this user.

Query parameters

environment'prod' | 'test'

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

Response

User details.

idstring

User identifier.

namestring nullable

User display name.

emailstring nullable

User email address.

customer_identifierstring

Your unique identifier for the user.

environment'prod' | 'test'

User environment.

total_budgetnumber nullable

Lifetime spending budget in USD.

period_budgetnumber nullable

Current period budget in USD.

organization_namestring nullable

Owning organization name.

total_period_usagenumber

Usage in the current budget period in USD.

period_startstring date-time

Start of the current budget period.

period_endstring date-time nullable

End of the current budget period.

budget_duration'daily' | 'weekly' | 'monthly'

Budget renewal period.

updated_atstring date-time

Last update timestamp.

Changes

  • c30bcb383ee8Revision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response's property type changed from number null to number, and format from double to no format for status

    • breaking

      the response's property type changed from number null to number, and format from double to no format for status

    • breaking

      the response's property format changed from double to no format for status

    • info

      api operation id users_retrieveUser removed and replaced with retrieveUser

    • info

      the endpoint scheme security DashboardJwt was added to the API

    • info

      api tag Users added

    • info

      api tag users removed

  • b830b79cfd52Revision changes
    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status