Sign in
users

List customers

Retrieve customers in your organization with analytics and budget fields. Available filter fields include customer_identifier, name, email, number_of_requests, total_tokens, total_cost, and active_days.

post/api/users/list/

Query parameters

pageinteger

Page number.

page_sizeinteger

Number of customers per page. Maximum is 1000.

sort_bystring

Sort field. Prefix with - for descending. Common values include customer_identifier, email, name, -first_seen, -number_of_requests, and -total_cost.

environment'prod' | 'test'

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

Headers

Authorizationstring required

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.

Request body

Response

Paginated list of customers.

countinteger required

Total number of matching customers.

nextstring nullable

Next page URL.

previousstring nullable

Previous page URL.

Changes