Get user
Returns the specified user’s profile and credit consumption data for a custom date range.
You can use the from and to parameters to specify the date range for credit consumption. If not specified, defaults to consumption during the current billing period.
You can also call List user apps to see the apps created by this user.
Authorizations
API key for authentication. See the Authentication page for your API for details on how to get your key.
Query Parameters
Start date in YYYY-MM-DD format. Required if to is provided. Defaults to billing period start.
End date in YYYY-MM-DD format. Required if from is provided. Defaults to current date.
Response
Successful Response
Detailed user information with consumption data.
Unique user identifier.
"usr_abc123"
User email address.
"jane.doe@company.com"
Deprecated: Workspace billing tier this user inherits. Use WorkspaceAnalytics.credit_pool.tier and the per-user member_allocation block instead. On the current billing model all members share the workspace tier, so this value is identical for every member.
User registration date in YYYY-MM-DDTHH:MM:SSZ format.
"2024-03-15T10:30:00Z"
Whether the user account is enabled (not disabled).
true
Workspace role. One of "owner", "admin", "editor", "viewer", "member", or "guest".
"member"
Total number of apps created by this user.
x >= 012
Whether the user consumed message credits in the last 30 days.
true
Total message credits consumed in the requested date range.
x >= 01250
Total integration credits consumed in the requested date range.
x >= 0340
Total credits consumed in the requested date range.
x >= 01590
Per-member credit limit status for the current credit reset period. null when the workspace tier does not enforce per-member limits.

