For AI agents: visit https://sigma-enterprise-group.readme.io/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
Sigma Computing
DocumentationAPI RecipesAPI ReferenceWhat's New
HomeCommunityQuickStartsStatusSigma Computing
API Reference
HomeCommunityQuickStartsStatus
DocumentationAPI RecipesAPI ReferenceWhat's New

GETTING STARTED

  • Get started with the Sigma REST API
    • Generate Sigma API client credentials
    • Identify unique IDs in Sigma
    • Use OAuth override tokens

Authentication

  • Get access tokenpost

Data models as code

  • Get the code representation of a data modelget
  • Create a data model from a code representationpost
  • Update a data model from a code representationput

Account Types

  • List account typesget
  • Create an account typepost
  • {accountTypeId}
    • List account type permissionsget
    • Delete an account typedel

connections

  • List connectionsget
  • Create a connectionpost
  • {connectionid}
    • Get connection detailsget
    • Update a connectionput
    • Delete a connectiondel
    • Test a connectionget
    • Update a connectionpatch
    • Add dbt metadata for a connectionpost
  • connection grants
    • List grants for a connectionget
    • Add grants to a connectionpost
    • Delete a grant for a connectiondel
  • paths
    • List connection pathsget
    • Get connection path for a tableget
    • Look up connections by pathpost
    • List columns for a warehouse tableget
    • Sync a connection by pathpost
    • path grants
      • List grants for a connection pathget
      • Add grants to a connection pathpost
      • Delete a grant for a connection pathdel

credentials

  • Create API credentialspost
  • Delete API credentialsdel

datasets

  • List datasets (Deprecated)get
  • Get a dataset (Deprecated)get
  • List dataset sources (Deprecated)get
  • materialization
    • Materialize a dataset (Deprecated)post
    • List materializations for a dataset (Deprecated)get
  • grants
    • Get grants for a dataset (Deprecated)get
    • Grant permissions on a dataset (Deprecated)post
    • Delete a permission granted on a dataset (Deprecated)del

Data Models

  • List data modelsget
  • Get a data modelget
  • {dataModelId}
    • List data model sourcesget
    • List tags for a data modelget
    • Tag a data modelpost
    • List materialization schedules for a data modelget
    • Get a materialization jobget
    • Run a scheduled materialization for a data model elementpost
    • Swap data model sourcespost
    • List lineage for a data modelget
    • List elements in a data modelget
    • List columns for all elements in a data modelget

Deployment Policies

  • List deployment policies (Beta)get
  • {deploymentPolicyId}
    • Get a deployment policy (Beta)get
    • Create a deployment policy (Beta)post
    • Update a deployment policy (Beta)patch
    • List tenants for a deployment policy (Beta)get
    • Archive a deployment policy (Beta)del
  • documents
    • Add documents to a deployment policy (Beta)post
    • List documents for a deployment policy (Beta)get
    • Remove a document from a deployment policy (Beta)del
  • tenants
    • List deployable tenant organizations (Beta)get
    • Add a tenant to a deployment policy (Beta)post
    • Remove a tenant from a deployment policy (Beta)del

Download

  • Download an exported fileget

favorites

  • Get favorite documents for a userget
  • Favorite a documentpost
  • Unfavorite a documentdel

files

  • List filesget
  • Create a filepost
  • {inodeId}
    • Get file informationget
    • Update a filepatch
    • Delete a filedel

grants

  • List grantsget
  • Create or update a grantpost
  • {grantId}
    • Get a grantget
    • Delete a grantdel

members

  • List members
    • List membersget
    • List members (Paginated)get
  • Create a memberpost
  • {memberId}
    • Get memberget
    • Update memberpatch
    • Deactivate memberdel
    • List teams for a memberget
    • List scheduled exports for a userget
    • Revoke a user's OAuth tokenspost
  • files
    • List member filesget
    • List recent files for a memberget
    • List all favorite documents of a memberget

organizations

  • Update organization settingspatch

REPORTS

  • List reportsget
  • Create a reportpost
  • {reportId}
    • Get a reportget
    • Duplicate a reportpost
    • List report sourcesget
    • Export a reportpost
    • Export data from a reportpost
    • schedule
      • List scheduled report exportsget
      • Add report schedulepost
      • Update a report schedulepatch
      • Delete a scheduled export for a reportdel

SAML

  • List SAML service providers (Beta)get
  • Create a SAML service provider certificate (Beta)post
  • {samlServiceProviderId}
    • List SAML service provider certificates (Beta)get
    • Get a SAML service provider certificate (Beta)get
    • Activate a SAML service provider certificate (Beta)post
    • Deactivate a SAML service provider certificate (Beta)post
    • Remove a SAML service provider certificate (Beta)del

shared templates

  • List templates shared with your organizationget
  • Accept a pending template sharepost
  • Delete a template sharedel
  • Share a workbook with another organizationpost

Sigma Tenants

  • List tenant organizations (Beta)get
  • Create a tenant organization (Beta)post
  • {tenantOrganizationId}
    • Get details for a tenant organization (Beta)get
    • Update details of a tenant organization (Beta)patch
    • Delete a tenant organization (Beta)del
    • Get deployed workbook in tenant organization (Beta)get
  • deployment capabilities
    • List tenant deployment capabilities (Beta)get
    • Add deployment capabilities to a tenant (Beta)post
    • Remove deployment capabilities from a tenant (Beta)post

Source Swap Policies

  • List source swap policies (Beta)get
  • Create a source swap policy (Beta)post
  • {policyId}
    • Get a source swap policy (Beta)get
    • Update a source swap policy (Beta)patch
    • Delete a source swap policy (Beta)del

API credentials

  • List API credentialsget
  • Create an API credentialpost
  • Get an API credentialget
  • Update an API credentialpatch
  • Delete an API credentialdel

API connectors

  • List API connectorsget
  • Create an API connectorpost
  • Get an API connectorget
  • Update an API connectorpatch
  • Delete an API connectordel

tags

  • Get tagsget
  • Create a tagpost
  • {tagId}
    • Update a tagpatch
    • Delete a tagdel
    • List workbooks for a tagget

teams

  • List teams
    • List teamsget
    • List teams (Paginated)get
  • Create a teampost
  • {teamId}
    • Get a teamget
    • Update a teampatch
    • Delete a teamdel
    • Get team user attributesget
    • Assign user attributes to a teampost
    • members
      • List team membersget
      • Update team memberspatch

templates

  • Get templateget
  • List templatesget
  • Create workbook from templatepost
  • Swap template data sourcespost

translations

  • List organization translation filesget
  • Create organization translation filepost
  • {lng}
    • Get organization translation fileget
    • Update organization translation fileput
    • Delete organization translation filedel
  • {lng_variant}
    • Get organization translation file with variantget
    • Update organization translation file with variantput
    • Delete organization translation file with variantdel

user attributes

  • List user attributesget
  • Create a user attributepost
  • {userAttributeId}
    • Get a user attributeget
    • Delete a user attributedel
  • teams
    • Get teams for a user attributeget
    • Set a user attribute for teamspost
    • Update a user attribute for teamspatch
    • Delete a user attribute for a teamdel
  • users
    • Get users for a user attributeget
    • Set a user attribute for userspost
    • Update a user attribute for userspatch
    • Delete a user attribute for a userdel
  • tenants
    • Get tenants for a user attributeget
    • Set a user attribute for tenants (Beta)post
    • Update a user attribute for tenants (Beta)patch
    • Delete a user attribute for a tenant (Beta)del

workbooks

  • List workbooksget
  • Create a workbookpost
  • {workbookId}
    • Get a workbookget
    • List workbook sourcesget
    • Get version history for a workbookget
    • Duplicate a workbookpost
    • Duplicate a tagged workbookpost
    • Swap workbook data sourcespost
    • Get workbook schemaget
    • List SQL queries in a workbookget
    • List workbook controlsget
    • Save a template from a workbookpost
    • List lineage for a workbookget
    • List elements in a workbookget
    • List columns for all elements in a workbookget
  • bookmarks
    • List bookmarks in a workbookget
    • Add a bookmark to a workbookpost
    • Get a bookmarkget
    • Update a workbook bookmarkpatch
    • Delete a bookmark from a workbookdel
    • List bookmarks in a tagged workbookget
    • Get a bookmark in a tagged workbookget
    • Update a bookmark in a tagged workbookpatch
    • Delete a bookmark from a tagged workbookdel
    • Add a bookmark to a tagged workbookpost
  • elements
    • List lineage of a workbook elementget
    • Get the SQL query for a workbook elementget
    • List columns for a workbook elementget
  • embeds
    • Get embeds for a workbookget
    • Create an embed for a workbookpost
    • Delete an embed from a workbookdel
  • exports
    • Export data from a workbookpost
    • Export a workbookpost
  • export schedules
    • List scheduled exports for a workbook
      • List scheduled workbook exportsget
      • List scheduled workbook exports (Paginated)get
    • Add workbook schedulepost
    • Update a workbook schedulepatch
    • Delete a scheduled export for a workbookdel
  • grants
    • Grant permissions on a workbook to users or teamspost
    • Delete a workbook grantdel
  • materializations
    • Get a materialization jobget
    • List materialization schedules for a workbook
      • List materialization schedules for a workbookget
      • List materialization schedules for a workbook (Paginated)get
    • Run a scheduled materialization for a workbook elementpost
  • pages
    • List workbook pages for a workbookget
    • List elements in a workbook pageget
  • tags
    • Get tags for a workbookget
    • Tag a workbookpost
    • Remove a tag from a workbookdel

workspaces

  • List workspaces
    • List workspacesget
    • List workspaces (Paginated)get
  • Create a workspacepost
  • {workspaceId}
    • Get a workspaceget
    • Update a workspacepatch
    • Delete a workspacedel
    • grants
      • Grant permissions to the workspace for users or teamspost
      • List grants for a workspaceget
      • Delete a workspace grantdel

whoami

  • Get current userget
Powered by 

Generate Sigma API client credentials

Updated 6 months ago


Get started with the Sigma REST API
Identify unique IDs in Sigma
Did this page help you?

Updated 6 months ago


Get started with the Sigma REST API
Identify unique IDs in Sigma
Did this page help you?
Resources
Sigma home
Blog
Learn
Sigma Community
© Sigma Computing