List all workbooks in the organization. Pass summary_only=True for concise token-efficient response.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read. limit is the page size.

Get workbook metadata.

Create an empty workbook in a folder.

Duplicate an existing workbook.

workbook_id: ID of the workbook to clone. name: Name for the new cloned workbook (required by the API). destination_folder_id: ID of the destination folder. If omitted, clones into the same folder as the original.

List pages in a workbook.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read.

List data lineage for a workbook.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read.

Get version history for a workbook.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read.

Restore a workbook to a previous version.

Convert a workbook to a report (one-way, creates a new report).

workbook_id: ID of the workbook to convert. name: Name for the new report (required by the API). destination_folder_id: Optional folder ID for the report; defaults to My Documents.

List permission grants on a workbook.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read.

Grant access to a workbook. grant_type: 'member' or 'team'. permission: 'view', 'explore', 'edit'.

List embed configurations for a workbook.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read.

Create an embed for a workbook.

embed_type: Visibility of the embed. Only 'public' is currently supported. source_type: Scope of the embed — 'workbook' (entire workbook), 'page', or 'element'. source_id: Required when source_type is 'page' or 'element'.

Export a workbook element. If element_id is empty, exports the first page.

format: 'pdf', 'png', 'csv', 'xlsx', 'json', 'jsonl'. layout: 'portrait' or 'landscape' (only for pdf/png). element_id: The specific element to export. If omitted, uses the first page element.

List every scheduled export for a workbook.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read.

Create a scheduled export for a workbook. See Sigma docs for schedule body schema.

Delete a scheduled export. Requires confirm=True.

List bookmarks (saved filter states) in a workbook.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read.

Add a bookmark to a workbook.

List tags on a workbook.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read.

Apply a version tag to a workbook by tag NAME (e.g. 'Production'). The Sigma API takes the tag name here, not its ID.

Remove a tag from a workbook. Requires confirm=True.

List all templates in the organization.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read. limit is the page size.

Get template details.

Create a workbook from a template. This brings real visuals — the only programmatic way to get charts/tables.

Save a workbook as a reusable template.

List all reports in the organization.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read. limit is the page size.

Get report metadata.

Create a report.

Duplicate a report.

report_id: ID of the report to clone. name: Name for the new cloned report (required by the API). destination_folder_id: ID of the destination folder to clone into (required by the API).

List data sources used by a report.

List elements in a report.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page and nextPageToken null, since every page is read.

List SQL queries in a report.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page and nextPageToken null, since every page is read.

List lineage for a report.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page and nextPageToken null, since every page is read.

Export a report. format: 'pdf', 'png', 'csv', 'xlsx'.

List scheduled exports for a report.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read.

Create a scheduled export for a report.

List templates shared with your organization from other orgs.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read.

Accept a pending template share from another organization.

Copy a workbook into a member's My Documents folder.

name: Optional name for the copied workbook. Defaults to the original workbook name.

Full deployment: instantiate a template into a folder, then optionally swap its sources.

Promote a workbook by tagging it (e.g., 'Production'). Creates tag if it doesn't exist.

Export a workbook/element and download the result. Polls until ready.

format: 'csv', 'pdf', 'xlsx', 'png'. layout: 'portrait' or 'landscape' (pdf only). parameters: Sigma control overrides e.g. {'DateRange': 'min:2024-01-01,max:2024-01-31'}. max_bytes: maximum allowed response size (default 10 MB). Returns size info without content if exceeded. Returns base64-encoded file content on success.

Transfer all workbooks from one member to another.

Resolves members by email, finds all workbooks owned by old owner, then PATCHes /v2/files/{id} to reassign. dry_run=True (default) reports what would change without making changes. Both arguments must be email addresses (Sigma looks members up by email only), and each must match exactly one member's email, ignoring case; otherwise the call fails before any change.

List all workbooks accessible to a member with full workbook metadata.

Cross-references member's file list against the full workbook catalog.

List ALL workbooks in the organization, automatically following pagination.

List ALL reports in the organization, automatically following pagination.

Update a workbook from a code representation (JSON document specification).

Mutating operation. Requires confirm=True and document_version integer to guard against concurrent overwrites.

Verify a workbook code representation specification without saving.

Validates schema structure, syntax, and element layout through a dry run of workbook creation (dryRun: true). Returns {valid, errors, warnings}. A success that does not echo dryRun: true fails the call (dry_run_not_honored) and names any ID that came back, since Sigma may then have created a real workbook.

Update a report from a code representation (JSON document specification).

Mutating operation. Requires confirm=True and document_version integer to guard against concurrent overwrites.

Verify a report code representation specification without saving.

Runs report creation as a dry run (dryRun: true). Returns {valid, errors, warnings}. A success that does not echo dryRun: true fails the call (dry_run_not_honored) and names any ID that came back, since Sigma may then have created a real report.

Download an exported query result file by queryId.

Returns the file content (JSON or text/CSV) or base64 binary (PDF, XLSX, PNG), or reports 'processing' if the query has not finished executing. max_bytes: Maximum allowed payload size in bytes (default 10 MB).

List AI agents defined in a specific workbook (optionally filtering by version tag).

Returns Sigma's single response. The spec documents no page-token request parameter for this endpoint, so a nextPageToken in the response cannot be followed.

Run an in-workbook AI agent with conversation messages.

Mutating / execution operation. Consumes LLM tokens. Requires confirm=True. messages: List of conversation turns (role: 'user', 'assistant', 'system', 'tool' with content). version_tag_name: Target published version tag (defaults to latest published version).

Delete a grant (a user's or team's permission) from a workbook. Requires confirm=True.

Retrieve grant IDs with workbooks_list_workbook_grants.

Delete an embed from a workbook. Requires confirm=True.

Retrieve embed IDs with workbooks_list_workbook_embeds. Embeds that use the embed URL stop working.

Export (send) a workbook once to one or more targets: email, Slack, Google Sheets/Drive, or a webhook.

body follows Sigma's POST /v2/workbooks/{workbookId}/send: target (list of targets), configV2 (format and element or page to export), plus optional parameters, conditions, timeout and sendAsUser.

Update a workbook's scheduled export.

body may set target, schedule (cronSpec, timezone), configV2, description and suspensionAction. Retrieve schedule IDs with workbooks_list_workbook_schedules.

Update a saved view (bookmark) in a workbook.

body may set name, isShared, isDefault and exploreKey. Retrieve bookmark IDs with workbooks_list_workbook_bookmarks.

Delete a saved view (bookmark) from a workbook. Requires confirm=True.

Duplicate the version of a workbook carrying a version tag into a folder as a new workbook.

tag_name is the version tag NAME (e.g. 'Production'). copy_bookmarks is "all" (every saved view; admins only) or "accessible" (personal saved views and those shared with the caller); leave it unset to copy none. Returns the new workbook.

Share a workbook with other Sigma organizations.

body requires orgSlugs (list of organization slugs) and may set shareDatasets, copyInputTableData, sendEmail and emailMessage.

Duplicate the version of a report carrying a version tag into a folder as a new report.

tag_name is the version tag NAME. Returns the new report.

List the pages of a report.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page and nextPageToken null, since every page is read.

List the elements on one page of a report. Retrieve page IDs with workbooks_list_report_pages.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page and nextPageToken null, since every page is read.

List the columns of every element in a report.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page and nextPageToken null, since every page is read.

Get the SQL query Sigma generates for a report element.

List the controls (filters and parameters) in a report.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page and nextPageToken null, since every page is read.

Get the version history of a report (published versions, who and when).

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page and nextPageToken null, since every page is read.

Export (send) a report once to one or more targets.

body requires targets, config and attachments, and may set parameters and timeout, per Sigma's POST /v2/reports/{reportId}/send.

Update a report's scheduled export.

body may set target, schedule, configV2, description and suspensionAction. Retrieve schedule IDs with workbooks_list_report_schedules.

Delete a report's scheduled export. Requires confirm=True.

Grant users or teams permission on a report.

body requires grants: a list of {grantee: {memberId} or {teamId}, permission: 'view' | 'edit'}.

Delete a grant from a report. Requires confirm=True.

List the version tags on a report.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page and nextPageToken null, since every page is read.

Apply a version tag to a report by tag NAME (e.g. 'Production'). The Sigma API takes the tag name here, not its ID.

Remove a version tag from a report. Requires confirm=True. Retrieve tag IDs with workbooks_list_report_tags.

Delete a template share. Requires confirm=True. Retrieve share IDs with workbooks_list_shared_templates.

List all connections in the Sigma organization. Pass summary_only=True for concise token-efficient response.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read.

Get details for a specific connection.

Force Sigma to re-index a warehouse path. Pass empty list for full sync.

Test connectivity for a connection.

List columns for a warehouse table by its tableId.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page and nextPageToken null, since every page is read.

List permission grants on a connection.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read.

Add a grant to a connection.

grant_type: 'member' or 'team'. permission: 'annotate' (Can Use & Annotate) or 'usage' (Can Use).

Delete a grant from a connection path. DESTRUCTIVE. Requires confirm=True.

List all data models in the organization. Pass summary_only=True for concise token-efficient response.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read. limit is the page size.

Get data model metadata.

Get the full code representation (JSON spec) of a data model — tables, columns, metrics, relationships.

Create a data model from a JSON code representation. Must include name, folderId, schemaVersion, and pages with elements.

Update an existing data model from a JSON code representation (full replacement via PUT).

List elements in a data model.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read.

List all columns across all elements in a data model.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read.

Swap data sources for a data model.

List lineage for a data model.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read.

Apply a version tag to a data model by tag NAME. The Sigma API takes the tag name here, not its ID.

Swap data sources on a report. Use connectionMapping for connection-level swaps, sourceMapping for table-level swaps.

Sync all tables in a warehouse schema so they become visible in Sigma.

Sync connections across all tenant organizations.

Lists all tenants, then for each tenant: obtains a tenant-scoped token, lists their connections, and syncs each one. Requires multi-tenant auth (for_tenant method). Uses bounded concurrency.

NOTE: Requires PyJWT and the for_tenant() method (Phase C). Returns an error if token exchange is not available.

List ALL data models in the organization, automatically following pagination.

Create a data warehouse connection.

body requires name and details (the warehouse type and its settings) and may set description, poolSizes, timeoutSecs and useFriendlyNames. The details may hold write-only secrets (password, privateKey, privateKeyPassphrase, clientSecret, token, pythonSecrets): pass them only from the user's own input. They are masked wherever Sigma's result or error echoes them.

Delete a connection. Requires confirm=True. Workbooks and data models built on it lose their source.

List connection paths (databases, schemas and tables) across all connections.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read.

Look up the object at a fully qualified path in a connection, e.g. ["DATABASE", "SCHEMA", "TABLE"] for Snowflake.

Read-only: the POST only resolves the path.

Delete a grant from a connection. Requires confirm=True. Retrieve grant IDs with datasets_list_connection_grants.

List grants on a connection path (database, schema or table).

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read.

Add grants to a connection path.

body requires grants: a list of {grantee: {memberId} or {teamId}, permission: 'annotate' | 'usage'}.

List the sources (tables, datasets, other data models) a data model reads from.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page and nextPageToken null, since every page is read.

Run the scheduled materialization for one data model element now.

sheet_id is the element's ID. Returns the materialization job; poll it with datasets_get_data_model_materialization.

Get the status of a data model materialization job.

List the materialization schedules of a data model.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page and nextPageToken null, since every page is read.

List the version tags on a data model.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read.

List elements on a specific page of a workbook.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read.

List all elements (tables, charts, controls, etc.) in a workbook.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read.

List all columns across all elements in a workbook, including formulas and types.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read.

List generated SQL queries for all elements in a workbook.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read.

List control elements (filters, parameters) in a workbook.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read.

List data sources used by a workbook.

Swap data sources for a workbook. Use connectionMapping for connection-level swaps, sourceMapping for table-level swaps.

Get the generated SQL query for a specific element in a workbook.

List columns for a specific element in a workbook.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read.

Trigger materialization for a workbook. Pass elementId in body if needed.

Check status of a materialization job.

List every materialization schedule for a workbook.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read.

Swap data sources on a template. Use connectionMapping for connection-level swaps, sourceMapping for table-level swaps.

List all source swap policies (rules for automatic source swapping on deployment).

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read.

Get a source swap policy.

Create a source swap policy for automated deployments.

Trigger materialization and poll until complete or timeout.

Scan all workbooks to find input-table elements.

Returns a list of input tables with their workbook, page, and element context. Errors on individual workbooks/pages are collected rather than silently swallowed.

Return a curated reference of common Sigma formula pitfalls — column reference syntax, type requirements, NULL handling, aggregate vs row-level context, date function argument order, and metrics vs calculated columns. Use this before writing any Sigma formula expression.

Search Sigma Computing documentation using AI-powered semantic search. Returns relevant doc passages with source URLs. Use this to answer questions about Sigma features, configuration, formulas, administration, embedding, and best practices.

read_only_hint: True

Fetch a specific Sigma documentation page as clean Markdown. Pass the page slug (e.g. 'create-a-workbook') or a section path (e.g. 'docs/create-a-workbook'). Returns the full page content.

read_only_hint: True

List the lineage (upstream sources and dependencies) of one workbook element.

Update a source swap policy (Beta).

body may set type, name, fromConnectionId and swaps.

Delete a source swap policy (Beta). Requires confirm=True.

Delete a file/workbook/data model by its inode ID. Requires confirm=True.

List files/folders. Optionally filter by parentId or type ('workbook', 'folder', 'data-model', 'template').

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read.

Create a folder.

Update file properties (name, parentId for moving).

List all tags in the organization.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read. page resumes from a nextPage cursor; limit is the page size.

Create a new tag (used for version promotion like 'Production', 'Staging').

Delete a tag. Requires confirm=True.

List all workspaces.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read. page resumes from a nextPage cursor; limit is the page size.

Get workspace details.

Create a new workspace.

Delete a workspace. Requires confirm=True.

List permission grants on a workspace.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read. page resumes from a nextPage cursor; limit is the page size.

Grant workspace access.

grant_type: 'member' or 'team'. permission: 'view', 'explore', 'organize' (Contribute), or 'edit' (Manage).

Delete a permission grant from a workspace. DESTRUCTIVE. Requires confirm=True.

List files/folders in the organization, automatically following pagination.

parent_id: Optional parent folder ID to list files within. type_filter: Optional file type filter ('workbook', 'folder', 'data-model', 'template', 'symlink'). Note: Shortcuts/symlinks are excluded by default unless type_filter='symlink'.

List the files (workbooks, data models, folders) a member can access.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read. limit is the page size.

List the files a member opened recently.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read.

Get a file's details (type, name, path, owner) by its inode ID.

Update a version tag.

body may set name, description and color.

List the workbooks carrying a version tag.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read.

Update (rename) a workspace.

body requires name and may set noDuplicates.

Add a document to a member's favorites.

Remove a document from a member's favorites. Requires confirm=True.

List a member's favorite documents.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read.

List all deployment policies.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page and nextPageToken null, since every page is read.

Get a deployment policy.

Create a deployment policy.

Delete (archive) a deployment policy. Requires confirm=True.

Deactivate a member. Requires confirm=True.

List documents in a deployment policy.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page and nextPageToken null, since every page is read.

Add workbooks/reports to a deployment policy.

List all tenant organizations (for multi-tenant deployments).

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page and nextPageToken null, since every page is read.

Get tenant organization details.

Create a tenant organization.

List all API connectors (custom data integrations).

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page and nextPageToken null, since every page is read.

Get details for an API connector.

List all members in the organization. Pass summary_only=True for concise token-efficient response.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read. limit is the page size.

Get member details including homeFolderId.

Create a new member. member_type: 'admin', 'creator', 'viewer'.

Update member properties (firstName, lastName, memberType, isActive, etc.).

Get the current authenticated user's details.

List teams a member belongs to.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read.

List all teams. Pass summary_only=True for concise token-efficient response.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read. limit is the page size.

Get team details.

Create a new team.

Delete a team. Requires confirm=True.

List members of a team.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read.

Add or remove members from a team. Provide lists of member IDs.

List all user attributes (used for row-level security and dynamic parameters).

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read.

Create a user attribute for RLS or dynamic parameters.

name: Attribute name (e.g. 'Region', 'CustomerID'). default_value: Default string value assigned when no override exists. description: Optional description of the attribute.

Set a user attribute value for specific teams.

assignments: List of objects, each with 'teamId' (str) and 'value' (str). Example: [{"teamId": "abc123", "value": "US"}]

Set a user attribute value for specific tenants.

assignments: List of objects, each with 'tenantOrganizationId' (str) and 'value' (str). Example: [{"tenantOrganizationId": "org123", "value": "US"}]

Get all user assignments for a user attribute.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read.

Get all team assignments for a user attribute.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read.

Get all tenant assignments for a user attribute.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read.

Revoke a user attribute assignment for specific users. Requires confirm=True.

user_ids: List of user IDs whose attribute assignments should be removed. Example: ["user-uuid-1", "user-uuid-2"]

To assign (not revoke), use admin_set_user_attribute_for_users instead.

Revoke a user attribute assignment for specific teams. Requires confirm=True.

team_ids: List of team IDs whose attribute assignments should be removed. Example: ["team-uuid-1", "team-uuid-2"]

Revoke a user attribute assignment for specific tenants. Requires confirm=True.

tenant_org_ids: List of tenant organization IDs whose attribute assignments should be removed. Example: ["org-uuid-1", "org-uuid-2"]

Delete a user attribute assignment for a specific user. DESTRUCTIVE. Requires confirm=True.

Delete a user attribute assignment for a specific team. DESTRUCTIVE. Requires confirm=True.

Delete a user attribute assignment for a specific tenant. DESTRUCTIVE. Requires confirm=True.

List all account types (license types) in the organization.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page and nextPageToken null, since every page is read.

List grants for a specific file/workbook/data model by inodeId. Required: inodeId.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read.

Create or update a grant. Body must include inodeId, granteeId, permission, type.

List organization translation files.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read.

Onboard a new member: create account then add to teams.

Add multiple members to a team in one call.

Deactivate members matching a name pattern (regex on firstName+lastName).

DESTRUCTIVE: requires both dry_run=False AND confirm=True to execute. Default behavior (dry_run=True) reports matches without making changes. Uses ?includeInactive=true to avoid re-deactivating already-inactive members.

Change a member's email address via PATCH /v2/members/{id}.

Remove multiple members from a team by their email addresses.

Resolves emails to member IDs, then sends a single PATCH to remove all. Requires confirm=True. An email is removed only when exactly one member's email equals it, ignoring case. An email that matches no member, or more than one, is listed in not_found and no one is removed for it; the other emails are still removed. If no email resolves, the call fails with not_found and nothing is sent.

List all tenants, following Sigma's cursor pagination to the last page.

GET /v2/tenants pages with pageSize/pageToken and answers nextPageToken (not limit/page/nextPage). Returns {"total": N, "tenants": [...]} with every tenant organization.

Demonstrate tenant token exchange by calling /whoami through a tenant-scoped client.

Uses RFC 8693 token exchange to obtain a tenant-scoped token, then calls the whoami endpoint to verify the scoped identity.

Describe what the Sigma REST API can and cannot do programmatically.

List ALL members in the organization, automatically following pagination.

List ALL teams in the organization, automatically following pagination.

List recently recorded incoming Sigma webhook events.

read_only_hint: True

List all workbook agents across the organization.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page and nextPageToken null, since every page is read. page_token resumes from a nextPageToken; page_size is the page size (spec maximum 100, the default).

Get organization setting value.

Update organization setting value.

Mutating operation. Requires confirm=True. setting_name: One of aiChatHistory, auditLogging, bulkCopy, comments, csvUpload, emailBranding, licenseUpgradeRequests, publicEmbeds, sampleConnections, timezone. setting_value: Dict containing setting fields to update.

Configure the organization AI provider and models.

Mutating operation. Requires confirm=True. provider_config: Provider specification dict (e.g. provider='openAI'/'anthropic'/'gemini'/'snowflake'/'databricks'/'bedrock'/'azureOpenAI').

Reset the organization email branding settings back to defaults.

Destructive operation. Requires confirm=True.

List IP allowlist entries configured for the organization (v3alpha).

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page and nextPageToken null, since every page is read. page_token resumes from a nextPageToken; page_size is the page size.

Create/add IP allowlist entries for the organization (v3alpha).

Mutating operation. Requires confirm=True. entries: List of dicts, each with 'ip' (IPv4/IPv6 or CIDR), 'scope' ('public-api', 'ui', or 'both'), and optional 'description'.

Delete IP allowlist entries by ID from the organization (v3alpha).

Destructive operation. Requires confirm=True. entry_ids: List of IP allowlist entry ID strings to delete.

Update a team.

body may set name, description and visibility.

Get a user attribute's definition.

Update a user attribute's definition.

body may set userAttributeName, description and defaultValue.

Delete a user attribute and every assignment of it. Requires confirm=True.

Set a user attribute value for specific users.

assignments: List of objects, each with 'userId' (str) and 'value' (str). Example: [{"userId": "abc123", "value": "US"}]

Create an account type.

body requires name, description and permissions.

Delete an account type. Requires confirm=True.

Get a grant by ID.

Delete a grant by ID. Requires confirm=True.

Update a deployment policy.

body may set name, nameInTenant, sourceSwapPolicies, copyInputTableData and useDependenciesWorkspace.

Remove a document from a deployment policy. Requires confirm=True.

List the tenant organizations deployments can target.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page and nextPageToken null, since every page is read.

List the tenants a deployment policy deploys to.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page and nextPageToken null, since every page is read.

Add a tenant to a deployment policy.

body requires tenantOrganizationId.

Remove a tenant from a deployment policy. Requires confirm=True.

Update a tenant organization.

body may set tenantOrganizationName and tenantOrganizationSlug.

Delete a tenant organization. Requires confirm=True.

List which tenant organizations a tenant can deploy to.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page and nextPageToken null, since every page is read.

Let a tenant deploy to more tenant organizations.

body requires deployToTenantOrganizationIds (list of tenant organization IDs).

Stop a tenant deploying to some tenant organizations. Requires confirm=True.

body requires deployToTenantOrganizationIds (list of tenant organization IDs).

Create an API connector.

body requires name and params and may set description, config and authId.

Update an API connector.

body may set name, description, params, config and authId.

Delete an API connector. Requires confirm=True.

List the API credentials API connectors use (metadata only).

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page and nextPageToken null, since every page is read.

Get an API credential's metadata.

Create an API credential for API connectors.

body requires name, allowlist and credential, and may set description. The credential holds a secret: pass it only from the user's own input.

Update an API credential.

body may set name, description, allowlist and credential.

Delete an API credential. Requires confirm=True. API connectors that use it stop authenticating.

Get the organization translation file for a language code (e.g. 'fr').

Get the organization translation file for a language code and variant.

Create the organization translation file for a language code.

body may set translations (key to translated string) and lng_variant.

Replace the organization translation file for a language code.

body requires translations.

Replace the organization translation file for a language code and variant.

body requires translations.

Delete the organization translation file for a language code. Requires confirm=True.

Delete the organization translation file for a language code and variant. Requires confirm=True.

List the scheduled exports a member owns.

Follows Sigma's pagination to the last page and returns the keys of Sigma's page: entries from every page, total when Sigma sends it (Sigma's value), and nextPage null (hasMore false where Sigma sends it) since every page is read.

Revoke a member's OAuth refresh tokens (OIDC single sign-on and warehouse connections). Requires confirm=True.

Sigma can no longer issue new access tokens for the member; the current session and already-issued access tokens last until their normal expiry.