This article is specific to Sigma's developer offerings. Release notes for the main Sigma product can be found on our What's New in Sigma page.

November 30, 2022

  • We added a new Team API endpoint that allows you to assign a user attribute to a team. Before you use this endpoint, you must create user attributes in the UI. For more information, see User Attributes
    POST /v2/user-attributes/{userAttributeId}/teams

See Team API to learn more about Team endpoints. 

August 25, 2022

  • Fixed: Teams APIs didn’t return Members field in Swagger.

August 23, 2022

  • Fixed: In some cases, a CSV uploaded to Databricks from Sigma rendered incorrectly.

July 28, 2022

We added 5 new endpoints to the Connection API. You can now create a connection, update a connection, test a connection, list active connections, and delete a connection with this API.  

  • Test Connection
  • Update/Restore Connection
  • Create Connection
  • Delete Connection
  • List Connections

See Connection API to learn more about these endpoints. 

July 1, 2022

  • Fixed: Workbook Export API. Attempts to export a workbook to JSON, if it used the CurrentUserInTeam function, returned an error.

June 22, 2022

  • Fixed: Admins couldn’t see all of their organization’s workspaces using the Workspaces API.

May 23, 2022

  • Custom plugin developers — We now send a warning message to your dev console if you should upgrade to a new version of @sigmacomputing/plugin.

May 19, 2022

  • Custom plugins support two new hooks: "useLoadingState" and "useEditorPanelConfig". 
    • "useLoadingState" allows you to override the plugin’s ready state, giving you more control over the loading laser beam.
    • "useEditorPanelConfig" allows you to dynamically set the editor panel during React runtime.
  • Fixed: Loading laser beams were left hanging on custom plugins. This was due to a lack of state change.

May 9, 2022

  • The workbook schema API can now return element names. This value — “displayName” — is only returned if the request has “includeSql” set to true.
  • Fixed: Plugins’ “useConfig” function expected a “key” argument but was marked optional in documentation.

May 5, 2022

  • Fixed: The workbook export API did not respect filter and parameter values when exporting as PDF or PNG.

April 27, 2022

  • Custom plugins support a new boolean config parameter: `screenshot`. When true, this parameter notifies the plugin that it should support screenshots for PDF exports.

April 26, 2022

  • Fixed: Some authorized users encountered an “Access Denied” error when calling Sigma’s workbook export API.

April 15, 2022

  • Fixed: Custom plugins did not display correctly in application embedded workbooks running on AWS.

April 11, 2022

  • Fixed: A plugin user hit the following error: "Could not find package required by '@sigmacomputing/plugin'". This issue has been resolved.

March 15, 2022

  • Plugins now support two new config “type” options: radio and dropdown. Learn more

March 11, 2022

Organization Members

POST /members
PATCH /v2/members/{memberId}
DELETE /v2/members/{memberId}


POST /v2/teams
GET /v2/teams/{teamId}
PATCH /v2/teams/{teamId}
DELETE /v2/teams/{teamId}

Team Members

PATCH /v2/teams/{teamId}/members


GET /v2/connections/{connectionId}
PATCH /v2/connections/{connectionId}

Connection Paths

GET /v2/connections/paths

Connection Grants

POST /v2/connections/{connectionId}/grants 
GET /v2/connections/{connectionId}/grants
DELETE /v2/connections/{connectionId}/grants/{grantId}


POST /v2/workspaces
GET /v2/workspaces
GET /v2/workspaces/{workspaceId}
PATCH /v2/workspaces/{workspaceId}
DELETE /v2/workspaces/{workspaceId}

Workspace Grants

POST /v2/workspaces/{workspaceId}/grants
GET /v2/workspaces/{workspaceId}/grants
DELETE /v2/workspaces/{workspaceId}/grants/{grantId}


March 4, 2022

  • Plugins now support two new config “type” options: toggle and checkbox. Learn more

December 8, 2021

  • The Team object returned from an individual team lookup request now includes a list of team member ids.
    Relates to: GET v2/teams/{teamId}

November 22, 2021

  • Workbook schema requests now accept an optional “includeSql” URL query (boolean). The API’s response will only include SQL if this value is true.
    Relates to: GET v2/workbooks/{workbookId}/schema

November 12, 2021

  • [Beta] Workbooks now support custom plugins. Use Sigma’s Plugin API to build custom visualizations for your team to use directly in Sigma. Get started

November 2, 2021