Skip to main content
GET
Get user

Authorizations

api_key
string
header
required

API key for authentication. See the Authentication page for your API for details on how to get your key.

Path Parameters

workspace_id
string
required
user_id
string
required

User ID. Get this from List users.

Query Parameters

from
string | null

Start date in YYYY-MM-DD format. Required if to is provided. Defaults to billing period start.

to
string | null

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.

user_id
string
required

Unique user identifier.

Example:

"usr_abc123"

email
string<email>
required

User email address.

Example:

"jane.doe@company.com"

seat_type
string
required
deprecated

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.

created_at
string
required

User registration date in YYYY-MM-DDTHH:MM:SSZ format.

Example:

"2024-03-15T10:30:00Z"

is_active
boolean
required

Whether the user account is enabled (not disabled).

Example:

true

role
string
required

Workspace role. One of "owner", "admin", "editor", "viewer", "member", or "guest".

Example:

"member"

total_apps
integer
required

Total number of active regular apps owned by this user.

Required range: x >= 0
Example:

12

total_superagents
integer
required

Total number of Super Agents owned by this user.

Required range: x >= 0
Example:

3

active_last_30d
boolean
required

Whether the user consumed message credits in the last 30 days.

Example:

true

total_message_credits
number
required

Total message credits consumed in the requested date range.

Required range: x >= 0
Example:

1250

total_integration_credits
number
required

Total integration credits consumed in the requested date range.

Required range: x >= 0
Example:

340

total_credits
number
required

Total credits consumed in the requested date range.

Required range: x >= 0
Example:

1590

member_allocation
MemberCreditAllocation · object | null

Per-member credit limit status for the current credit reset period. null when the workspace tier does not enforce per-member limits.