List users (admin)
Coming soon
The v2 MCP API is in preview and not yet generally available. These pages document its tools and request/response shapes; live data access is limited to enrolled organizations until v2 is released.
List org members + invited users with role, status, API key count, and lifetime credit usage. Supports filtering and cursor pagination. Requires an admin-scoped API key.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
role | string | - | Filter by role. |
status | string | - | Filter by membership status. active = team_membership exists; invited = unexpired sent invitation. |
limit | integer | - | Page size (1-500, default 100). |
cursor | string | - | Opaque pagination cursor returned in nextCursor of a prior page. |
Response Format
| Field | Type | Description |
|---|---|---|
users | array | Users page (up to limit items). Use nextCursor to fetch the next page. |
users[].userId | string | null | ID of the public.users row. Null for invited-only rows that have no public.users row yet. |
users[].email | string | |
users[].name | string | null | |
users[].role | string | |
users[].status | string | active = team_membership row exists; invited = unexpired team_invitations row with status='sent'. |
users[].createdAt | string | ISO timestamp; team_membership.createdAt for active, invitation.sentAt for invited. |
users[].apiKeyCount | integer | Count of non-system-managed API keys for this user in this org. |
users[].lifetimeCredits | number | All-time sum of credits consumed by this user × org across all tool_metering rows. Rounded to 6 decimals. |
nextCursor | string | null | Opaque cursor for the next page; null when no more results. |