v4

latestOpenAPI 3.1.0Proprietary2026-08-01113851.0 KB
Budgets

List Account and Workspace budgets

Returns spending controls for the authenticated Account and Agent usage limits for its Workspaces, groups, and members. Account spending controls apply to usage-based spend. Workspace, group, and member limits apply to Agent usage during the current billing cycle.

Account spending controls are included unless excluded by a type or Workspace filter. A null threshold means that control is not configured. Workspace, group, and member limits are included only when configured.

When multiple filters are provided, all filters apply. Supplying workspaceId excludes Account spending controls. Therefore, combining workspaceId with type=account_spending_controls returns an empty page.

Results are ordered by type, then workspaceId, then group or member ID. Pagination cursors are tied to the authenticated Account and the original type, workspaceId, and limit values. Reusing a cursor with different parameters returns invalid_request.

get/budgets

Query parameters

workspaceIdstring

Restrict results to a workspace owned by the authenticated Account.

type'account_spending_controls' | 'workspace_default_user_limit' | 'workspace_group_limit' | 'workspace_user_limit'

Filter results by budget type.

limitinteger

Maximum number of records to return.

cursorstring

Opaque pagination cursor returned by the previous response.

Response

Configured spending controls and Agent usage limits.