Sign in
Internal User management

Get Users

Get a paginated list of users with filtering and sorting options.

Parameters: role: Optional[str] Filter users by role. Can be one of: - proxy_admin - proxy_admin_viewer - internal_user - internal_user_viewer user_ids: Optional[str] Get list of users by user_ids. Comma separated list of user_ids. sso_ids: Optional[str] Get list of users by sso_ids. Comma separated list of sso_ids. user_email: Optional[str] Filter users by partial email match search: Optional[str] Combined search: matches users whose user_id or user_email contains the value (case-insensitive) team: Optional[str] Filter users by team id. Will match if user has this team in their teams array. page: int The page number to return page_size: int The number of items per page sort_by: Optional[str] Column to sort by (e.g. 'user_id', 'user_email', 'created_at', 'spend') sort_order: Optional[str] Sort order ('asc' or 'desc')

get/user/list

Query parameters

rolestring nullable

Filter users by role

Filter users by role

user_idsstring nullable

Get list of users by user_ids

Get list of users by user_ids

sso_user_idsstring nullable

Get list of users by sso_user_id

Get list of users by sso_user_id

user_emailstring nullable

Filter users by partial email match

Filter users by partial email match

searchstring nullable

Combined search: matches users whose 'user_id' or 'user_email' contains the value (case-insensitive).

Combined search: matches users whose 'user_id' or 'user_email' contains the value (case-insensitive).

teamstring nullable

Filter users by team id

Filter users by team id

pageinteger

Page number

Page number

page_sizeinteger

Number of items per page

Number of items per page

sort_bystring nullable

Column to sort by (e.g. 'user_id', 'user_email', 'created_at', 'spend')

Column to sort by (e.g. 'user_id', 'user_email', 'created_at', 'spend')

sort_orderstring

Sort order ('asc' or 'desc')

Sort order ('asc' or 'desc')

organization_idsstring nullable

Filter users by organization membership. Comma-separated list of org IDs.

Filter users by organization membership. Comma-separated list of org IDs.

Response

Successful Response

totalinteger required
pageinteger required
page_sizeinteger required
total_pagesinteger required

Changes