Skip to navigation
Sigma REST APIOrganizationsaiBudgets

List AI budget assignments (Beta)

View as Markdown

List the monthly AI budgets assigned to users, teams, and account types in the organization.

Beta: This documentation describes a public beta feature and is subject to the Beta features disclaimer.

Usage notes

  • To perform this operation, you must use API credentials owned by a user assigned the Admin account type.
  • A member’s budget comes from the most specific assignment that applies to them: a member assignment, then a team assignment, then an account type assignment, then the organization’s default budget. When a member belongs to several teams with assignments, the team assignment with the highest precedence applies.
  • By default, the list includes all assignee types. Use the precedence key for all teams to identify how budget assignments apply to team members. Compare keys across pages rather than relying on list order.
  • Assignments for deleted users, teams, or account types remain in the list until explicitly deleted.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Query parameters

pageTokenstringOptional

Use to specify the next set of results with the string returned in the nextPageToken field of the previous response.

pageSizeintegerOptional
Number of results to return per page, with a maximum of 1000. Defaults to 50.
typeenumOptional
Assignee type to include.
Allowed values:
memberIdstringOptional
Filter by member or user ID.
teamIdstringOptional
Filter by team ID.
accountTypeIdstringOptional
Filter by account type ID.

Response

The response body.
entrieslist of objects
Array of results returned by the endpoint
nextPageTokenstringOptional

A string that can be passed to the pageToken parameter in the next request to fetch the next page of results. Not present in the last page of results. Must be treated as an opaque string.