API Recipes

Ready-to-use code samples for common Sigma API workflows. Click any recipe to view the code sample and instructions.

Get Access Token

This script retrieves a bearer token from the Sigma API using client credentials authentication.

List All Connections

This script lists all connections in alphabetically order by name.

Sync All Tables in Schema

This script automates the synchronization of tables within a specified schema (Snowflake).

Get Column Names by Page and Element

Retrieves column names for all elements across each page of a workbook.

Get Member Details

Retrieves detailed information about a specific member in your Sigma organization.

Member Onboarding

Automates new member creation, team assignment, and workspace folder setup.

Bulk Deactivate Members

This script deactivates and deletes all users found using a single parameter that can be configured as a wildcard.

Change Email Address

Updates a member's email address using the Sigma API.

Create New Member

Creates a new member in your Sigma organization with specified details.

List All Members

Lists all members in your Sigma organization with their details.

Recent Workbooks

Retrieves recently accessed workbooks for a specific member.

Updates an existing member's properties such as name and account type.

Bulk Assign Members

Assigns multiple members to a team based on a name pattern.

Bulk Remove Members

Removes multiple members from a team based on a name pattern.

Bulk Sync Connection Paths

Syncs connection paths for multiple tenants, useful for multi-tenant embedded analytics.

Copy Workbook to My Documents

Copies a workbook to a specific member's My Documents folder.

Export to CSV with Date Range

Exports workbook data to CSV with date range parameters applied.

This script triggers an export to PDF job and downloads the export once ready.

Initiate Materialization Job

Triggers a materialization job for a specified workbook element.

List All Workbooks

Lists all workbooks in your Sigma organization.

Demonstrates how to paginate through large result sets from the Sigma API.

Reassign Ownership by Email

Reassigns workbook ownership from one member to another using email addresses.

Lists all workbooks shared with the authenticated member.

List All Input Tables

Lists all input tables across all workbooks in your organization.

Updates the owner of one or more workbooks.