# Sigma Computing

> Work with Sigma's workbooks: export them as PDF, Excel or CSV, email them now or on a schedule, and refresh materializations. Manage members and teams, list connections, data models and workspaces, and start workflows when workbooks, members, teams or data models are added or changed.

App · 25 actions. Web page: https://docs.lodol.com/docs/integrations/sigma-computing

## Actions

### Add member

Add a user to the Sigma organization, with an account type and teams. Sigma emails them an invitation unless told not to. Needs Admin credentials.

**Inputs**

- Email (`email`, text, required): Their email address.
- First name (`first_name`, text, required): Their first name.
- Last name (`last_name`, text, required): Their last name.
- Account type (`account_type`, text): Their account type, such as Admin, Creator or Viewer. Leave empty for your organization's default.
- Kind of user (`user_kind`, text): An internal user, a guest from outside, or an embed user. One of: `internal` (Internal user), `guest`, `embed` (Embed user).
- Teams (`team_ids`, list): Teams to add them to.
- Send an invitation (`send_invite`, true/false): Email them an invitation. On unless turned off.

**Outputs**

- `member` (object): The member

**Example output**

```json
{
  "member": {
    "createdAt": "2026-09-01T08:00:00Z",
    "createdBy": "pX1pjf3n4bGqwBx2Hc3sbT1LkG0u2",
    "email": "jo@example.com",
    "firstName": "Jo",
    "homeFolderId": "9f8e7d6c-5b4a-4c3d-2e1f-0a9b8c7d6e5f",
    "isArchived": false,
    "isInactive": false,
    "lastName": "Bloggs",
    "memberId": "pX1pjf3n4bGqwBx2Hc3sbT1LkG0u2",
    "memberType": "Creator",
    "organizationId": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
    "profileImgUrl": "",
    "updatedAt": "2026-10-15T09:30:00Z",
    "updatedBy": "pX1pjf3n4bGqwBx2Hc3sbT1LkG0u2",
    "userKind": "internal"
  }
}
```

### Add or remove team members

Add members to a team, remove members from it, or both at once.

**Inputs**

- Team (`sigma_team_id`, text, required): The team. Pick one, or give its id from an earlier step.
- Members to add (`add_member_ids`, list): Members to add to the team.
- Members to remove (`remove_member_ids`, list): Members to take off the team.

**Outputs**

- `added` (list): Members added
- `removed` (list): Members removed
- `team_id` (text): The team

**Example output**

```json
{
  "added": [
    "pX1pjf3n4bGqwBx2Hc3sbT1LkG0u2"
  ],
  "removed": [],
  "team_id": "3c4d5e6f-7a8b-4c9d-8e0f-1a2b3c4d5e6f"
}
```

### Create team

Create a team, optionally with members and a team folder.

**Inputs**

- Name (`name`, text, required): The team's name.
- Description (`description`, text): What the team is for.
- Visibility (`visibility`, text): Whether everyone can see the team, or only its members. One of: `private` (Private (default)), `public`.
- Members (`member_ids`, list): Members to put in the team.
- Create a team folder (`create_team_folder`, true/false): Also make a shared folder for the team.

**Outputs**

- `team` (object): The team

**Example output**

```json
{
  "team": {
    "createdAt": "2026-10-15T09:30:00Z",
    "createdBy": "pX1pjf3n4bGqwBx2Hc3sbT1LkG0u2",
    "description": "The finance team.",
    "isArchived": false,
    "members": [
      "pX1pjf3n4bGqwBx2Hc3sbT1LkG0u2"
    ],
    "name": "Finance",
    "teamId": "3c4d5e6f-7a8b-4c9d-8e0f-1a2b3c4d5e6f",
    "updatedAt": "2026-10-15T09:30:00Z",
    "updatedBy": "pX1pjf3n4bGqwBx2Hc3sbT1LkG0u2",
    "visibility": "private",
    "workspaceId": ""
  }
}
```

### Deactivate member

Deactivate a member so they can no longer sign in. Their documents pass to the owner of the API credentials. Sigma never deletes users. Needs Admin credentials.

**Inputs**

- Member (`member_id`, text, required): The member. Pick one, or give their id from an earlier step.

**Outputs**

- `deactivated` (true/false): True once deactivated
- `member_id` (text): The member deactivated

**Example output**

```json
{
  "deactivated": true,
  "member_id": "pX1pjf3n4bGqwBx2Hc3sbT1LkG0u2"
}
```

### Delete scheduled export

Delete one of a workbook's scheduled exports, so it stops sending.

**Inputs**

- Workbook (`workbook_id`, text, required): The workbook. Pick one, or give its id from an earlier step.
- Scheduled export (`schedule_id`, text, required): The scheduled export. Pick one, or give its id.

**Outputs**

- `deleted` (true/false): True once deleted
- `schedule_id` (text): The scheduled export deleted
- `workbook_id` (text): The workbook

**Example output**

```json
{
  "deleted": true,
  "schedule_id": "0e1f2a3b-4c5d-4e6f-8a9b-0c1d2e3f4a5b",
  "workbook_id": "6a5d1e2c-3b4f-4a8e-9c7d-1f2e3d4c5b6a"
}
```

### Delete team

Delete a team. Its members stay in the organization.

**Inputs**

- Team (`sigma_team_id`, text, required): The team. Pick one, or give its id from an earlier step.

**Outputs**

- `deleted` (true/false): True once deleted
- `team_id` (text): The team deleted

**Example output**

```json
{
  "deleted": true,
  "team_id": "3c4d5e6f-7a8b-4c9d-8e0f-1a2b3c4d5e6f"
}
```

### Download export

Get the file of an export 'Export workbook' started, by its query id, and save it in Lodol. Says not ready if Sigma is still making it. Sigma keeps an export for an hour.

**Inputs**

- Query ID (`query_id`, text, required): The 'query_id' 'Export workbook' returned.
- Format (`file_format`, text): The format the export was made in, to name the file. Leave empty to tell from Sigma's answer. One of: `pdf`, `xlsx` (Excel (XLSX)), `csv` (CSV (one element only)), `png` (PNG image (a page or element)), `json` (JSON (one element only)), `jsonl` (JSON Lines (one element only)).

**Outputs**

- `content_type` (text): The file's type; empty if not ready
- `document_ref` (text): The file saved in Lodol, to attach or upload; empty if not ready
- `filename` (text): The file's name; empty if not ready
- `format` (text): The file's format, such as pdf
- `query_id` (text): The export's id, for 'Download export' (valid for an hour)
- `ready` (true/false): Whether the file was ready; false means try 'Download export' later
- `size_bytes` (number): The file's size in bytes; 0 if not ready

**Example output**

```json
{
  "content_type": "application/pdf",
  "document_ref": "doc_01HXSIGMAEXPORT",
  "filename": "sigma-6a5d1e2c-3b4f-4a8e-9c7d-1f2e3d4c5b6a.pdf",
  "format": "pdf",
  "query_id": "88889999-aaaa-bbbb-cccc-ddddeeeeffff",
  "ready": true,
  "size_bytes": 48213
}
```

### Export workbook

Export a workbook, one page or one element as a PDF, Excel, CSV, PNG or JSON file and save it in Lodol, to attach to an email or upload. Waits up to about 45 seconds; a bigger export returns its query id for 'Download export'.

**Inputs**

- Workbook (`workbook_id`, text, required): The workbook. Pick one, or give its id from an earlier step.
- Format (`file_format`, text, required): The file to make. A whole workbook can be PDF or Excel; a page PDF, PNG or Excel; an element any of them, including CSV and JSON. One of: `pdf`, `xlsx` (Excel (XLSX)), `csv` (CSV (one element only)), `png` (PNG image (a page or element)), `json` (JSON (one element only)), `jsonl` (JSON Lines (one element only)).
- Workbook page (`page_id`, text): Export only this page. Leave empty for the whole workbook.
- Element (`element_id`, text): Export only this element, such as one table. Leave empty for the whole workbook (or the page chosen).
- PDF layout (`pdf_layout`, text): Portrait or landscape, for a PDF. Defaults to portrait. One of: `portrait` (Portrait (default)), `landscape`.
- Row limit (`row_limit`, number): At most this many rows, for CSV, Excel or JSON (Sigma's limit is 1,000,000). From 1 to 1000000.
- Control values (`control_values`, object): Filter the export by setting the workbook's controls, as control id and value, such as {"Region": "West"}.

**Outputs**

- `content_type` (text): The file's type; empty if not ready
- `document_ref` (text): The file saved in Lodol, to attach or upload; empty if not ready
- `filename` (text): The file's name; empty if not ready
- `format` (text): The file's format, such as pdf
- `query_id` (text): The export's id, for 'Download export' (valid for an hour)
- `ready` (true/false): Whether the file was ready; false means try 'Download export' later
- `size_bytes` (number): The file's size in bytes; 0 if not ready

**Example output**

```json
{
  "content_type": "application/pdf",
  "document_ref": "doc_01HXSIGMAEXPORT",
  "filename": "sigma-6a5d1e2c-3b4f-4a8e-9c7d-1f2e3d4c5b6a.pdf",
  "format": "pdf",
  "query_id": "88889999-aaaa-bbbb-cccc-ddddeeeeffff",
  "ready": true,
  "size_bytes": 48213
}
```

### Get current user

Get the Sigma member the connection acts as (the owner of the API credentials): their id, organization, name, email and account type.

**Inputs**: None.

**Outputs**

- `account_type` (text): Their account type, such as Admin
- `email` (text): Their email address
- `first_name` (text): First name
- `last_name` (text): Last name
- `member` (object): Their whole member record
- `organization_id` (text): The organization's id
- `user_id` (text): The member's id

**Example output**

```json
{
  "account_type": "Creator",
  "email": "jo@example.com",
  "first_name": "Jo",
  "last_name": "Bloggs",
  "member": {
    "createdAt": "2026-09-01T08:00:00Z",
    "createdBy": "pX1pjf3n4bGqwBx2Hc3sbT1LkG0u2",
    "email": "jo@example.com",
    "firstName": "Jo",
    "homeFolderId": "9f8e7d6c-5b4a-4c3d-2e1f-0a9b8c7d6e5f",
    "isArchived": false,
    "isInactive": false,
    "lastName": "Bloggs",
    "memberId": "pX1pjf3n4bGqwBx2Hc3sbT1LkG0u2",
    "memberType": "Creator",
    "organizationId": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
    "profileImgUrl": "",
    "updatedAt": "2026-10-15T09:30:00Z",
    "updatedBy": "pX1pjf3n4bGqwBx2Hc3sbT1LkG0u2",
    "userKind": "internal"
  },
  "organization_id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
  "user_id": "pX1pjf3n4bGqwBx2Hc3sbT1LkG0u2"
}
```

### Get materialization

Get a materialization job's status: when it started and finished, and why it failed if it did.

**Inputs**

- Workbook (`workbook_id`, text, required): The workbook. Pick one, or give its id from an earlier step.
- Materialization ID (`materialization_id`, text, required): The 'materialization_id' 'Run materialization' returned.

**Outputs**

- `error` (text): Why it failed; empty if it didn't
- `finished` (true/false): Whether it has finished, well or not
- `materialization` (object): The job
- `status` (text): Sigma's word for where it is, such as ready

**Example output**

```json
{
  "error": "",
  "finished": true,
  "materialization": {
    "error": "",
    "expiredAt": "2026-10-16T09:31:12Z",
    "materializationId": "m-4f3e2d1c",
    "readyAt": "2026-10-15T09:31:12Z",
    "startedAt": "2026-10-15T09:30:00Z",
    "status": "ready"
  },
  "status": "ready"
}
```

### Get member

Get one member: their name, email, account type and whether they are active.

**Inputs**

- Member (`member_id`, text, required): The member. Pick one, or give their id from an earlier step.

**Outputs**

- `member` (object): The member

**Example output**

```json
{
  "member": {
    "createdAt": "2026-09-01T08:00:00Z",
    "createdBy": "pX1pjf3n4bGqwBx2Hc3sbT1LkG0u2",
    "email": "jo@example.com",
    "firstName": "Jo",
    "homeFolderId": "9f8e7d6c-5b4a-4c3d-2e1f-0a9b8c7d6e5f",
    "isArchived": false,
    "isInactive": false,
    "lastName": "Bloggs",
    "memberId": "pX1pjf3n4bGqwBx2Hc3sbT1LkG0u2",
    "memberType": "Creator",
    "organizationId": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
    "profileImgUrl": "",
    "updatedAt": "2026-10-15T09:30:00Z",
    "updatedBy": "pX1pjf3n4bGqwBx2Hc3sbT1LkG0u2",
    "userKind": "internal"
  }
}
```

### Get workbook

Get one workbook: its name, link, folder, owner, versions and tags.

**Inputs**

- Workbook (`workbook_id`, text, required): The workbook. Pick one, or give its id from an earlier step.

**Outputs**

- `workbook` (object): The workbook

**Example output**

```json
{
  "workbook": {
    "createdAt": "2026-09-01T08:00:00Z",
    "createdBy": "pX1pjf3n4bGqwBx2Hc3sbT1LkG0u2",
    "description": "Sales by region, refreshed daily.",
    "isArchived": false,
    "latestVersion": 12,
    "name": "Weekly sales",
    "ownerId": "pX1pjf3n4bGqwBx2Hc3sbT1LkG0u2",
    "path": "My Documents",
    "tags": [
      {
        "isArchived": false,
        "name": "Production",
        "sourceWorkbookVersion": 11,
        "taggedWorkbookId": "7b6e2f3d-4c5a-4b9f-8d8e-2a3b4c5d6e7f",
        "versionTagId": "c1d2e3f4-0000-4a8e-9c7d-1f2e3d4c5b6a",
        "workbookTaggedAt": "2026-10-15T09:30:00Z"
      }
    ],
    "updatedAt": "2026-10-15T09:30:00Z",
    "updatedBy": "pX1pjf3n4bGqwBx2Hc3sbT1LkG0u2",
    "url": "https://app.sigmacomputing.com/acme/workbook/Weekly-sales-2NqdWzJHQ8DsLqk3hA9X1b",
    "workbookId": "6a5d1e2c-3b4f-4a8e-9c7d-1f2e3d4c5b6a",
    "workbookUrlId": "2NqdWzJHQ8DsLqk3hA9X1b"
  }
}
```

### List connections

List the data warehouse connections (Snowflake, BigQuery, Databricks and others) Sigma reads from, and when each was last used.

**Inputs**

- Name contains (`search`, text): Only connections whose name has these words.
- Page size (`page_size`, number): How many to return, 1 to 1,000. Defaults to 50. From 1 to 1000.
- Next page (`page`, text): The 'next_page' from an earlier run of this step, to get the page after it.

**Outputs**

- `connections` (list): The connections
- `count` (number): How many are on this page
- `next_page` (text): Give this as 'Next page' to get the next page; empty on the last page
- `total` (number): How many there are in all

**Example output**

```json
{
  "connections": [
    {
      "connectionId": "5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b",
      "createdAt": "2026-01-10T08:00:00Z",
      "createdBy": "pX1pjf3n4bGqwBx2Hc3sbT1LkG0u2",
      "isArchived": false,
      "isAuditLog": false,
      "isSample": false,
      "lastActiveAt": "2026-10-15T09:30:00Z",
      "name": "Snowflake production",
      "organizationId": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
      "type": "snowflake",
      "updatedAt": "2026-10-15T09:30:00Z",
      "updatedBy": "pX1pjf3n4bGqwBx2Hc3sbT1LkG0u2",
      "useOauth": false
    }
  ],
  "count": 1,
  "next_page": "",
  "total": 1
}
```

### List data models

List the data models you can see, with their links and versions.

**Inputs**

- Page size (`page_size`, number): How many to return, 1 to 1,000. Defaults to 50. From 1 to 1000.
- Next page (`page`, text): The 'next_page' from an earlier run of this step, to get the page after it.

**Outputs**

- `count` (number): How many are on this page
- `data_models` (list): The data models
- `next_page` (text): Give this as 'Next page' to get the next page; empty on the last page
- `total` (number): How many there are in all

**Example output**

```json
{
  "count": 1,
  "data_models": [
    {
      "createdAt": "2026-08-01T08:00:00Z",
      "createdBy": "pX1pjf3n4bGqwBx2Hc3sbT1LkG0u2",
      "dataModelId": "8b9c0d1e-2f3a-4b4c-8d5e-6f7a8b9c0d1e",
      "dataModelUrlId": "4Hk2PqRs7Tu9Vw1Xy3Za5b",
      "isArchived": false,
      "latestVersion": 4,
      "name": "Orders model",
      "ownerId": "pX1pjf3n4bGqwBx2Hc3sbT1LkG0u2",
      "path": "Workspaces/Finance",
      "updatedAt": "2026-10-15T09:30:00Z",
      "updatedBy": "pX1pjf3n4bGqwBx2Hc3sbT1LkG0u2",
      "url": "https://app.sigmacomputing.com/acme/data-model/Orders-model-4Hk2PqRs7Tu9Vw1Xy3Za5b"
    }
  ],
  "next_page": "",
  "total": 1
}
```

### List materialization schedules

List a workbook's materialization schedules: which elements Sigma saves to the warehouse, and when.

**Inputs**

- Workbook (`workbook_id`, text, required): The workbook. Pick one, or give its id from an earlier step.
- Page size (`page_size`, number): How many to return, 1 to 1,000. Defaults to 50. From 1 to 1000.
- Next page (`page`, text): The 'next_page' from an earlier run of this step, to get the page after it.

**Outputs**

- `count` (number): How many are on this page
- `next_page` (text): Give this as 'Next page' to get the next page; empty on the last page
- `schedules` (list): The materialization schedules
- `total` (number): How many there are in all

**Example output**

```json
{
  "count": 1,
  "next_page": "",
  "schedules": [
    {
      "configuredAt": "2026-10-15T09:30:00Z",
      "elementId": "xQ3a9Lm2Pz",
      "elementName": "Sales by region",
      "paused": false,
      "schedule": {
        "cronSpec": "0 9 * * 1",
        "timezone": "America/New_York"
      },
      "sheetId": "kJ8s2Lq0Wm"
    }
  ],
  "total": 1
}
```

### List members

List the organization's members (users), or find one by email. Gets one page; to see more, run it again with the next page it gives.

**Inputs**

- Email (`email`, text): Only the member with this email address.
- Include deactivated members (`include_deactivated`, true/false): Also list members who were deactivated.
- Page size (`page_size`, number): How many to return, 1 to 1,000. Defaults to 50. From 1 to 1000.
- Next page (`page`, text): The 'next_page' from an earlier run of this step, to get the page after it.

**Outputs**

- `count` (number): How many are on this page
- `members` (list): The members
- `next_page` (text): Give this as 'Next page' to get the next page; empty on the last page
- `total` (number): How many there are in all

**Example output**

```json
{
  "count": 1,
  "members": [
    {
      "createdAt": "2026-09-01T08:00:00Z",
      "createdBy": "pX1pjf3n4bGqwBx2Hc3sbT1LkG0u2",
      "email": "jo@example.com",
      "firstName": "Jo",
      "homeFolderId": "9f8e7d6c-5b4a-4c3d-2e1f-0a9b8c7d6e5f",
      "isArchived": false,
      "isInactive": false,
      "lastName": "Bloggs",
      "memberId": "pX1pjf3n4bGqwBx2Hc3sbT1LkG0u2",
      "memberType": "Creator",
      "organizationId": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
      "profileImgUrl": "",
      "updatedAt": "2026-10-15T09:30:00Z",
      "updatedBy": "pX1pjf3n4bGqwBx2Hc3sbT1LkG0u2",
      "userKind": "internal"
    }
  ],
  "next_page": "",
  "total": 1
}
```

### List scheduled exports

List a workbook's scheduled exports: when each runs, what it sends and whether it is on.

**Inputs**

- Workbook (`workbook_id`, text, required): The workbook. Pick one, or give its id from an earlier step.
- Page size (`page_size`, number): How many to return, 1 to 1,000. Defaults to 50. From 1 to 1000.
- Next page (`page`, text): The 'next_page' from an earlier run of this step, to get the page after it.

**Outputs**

- `count` (number): How many are on this page
- `next_page` (text): Give this as 'Next page' to get the next page; empty on the last page
- `schedules` (list): The scheduled exports
- `total` (number): How many there are in all

**Example output**

```json
{
  "count": 1,
  "next_page": "",
  "schedules": [
    {
      "configV2": {
        "messageBody": "This week's numbers.",
        "notificationAttachments": [
          {
            "formatOptions": {
              "type": "PDF"
            }
          }
        ],
        "title": "Weekly sales"
      },
      "createdAt": "2026-10-15T09:30:00Z",
      "createdBy": "pX1pjf3n4bGqwBx2Hc3sbT1LkG0u2",
      "disabledAt": "",
      "disabledBy": "",
      "isSuspended": false,
      "lastUpdatedByUser": "pX1pjf3n4bGqwBx2Hc3sbT1LkG0u2",
      "ownerId": "pX1pjf3n4bGqwBx2Hc3sbT1LkG0u2",
      "schedule": {
        "cronSpec": "0 9 * * 1",
        "timezone": "America/New_York"
      },
      "scheduledNotificationId": "0e1f2a3b-4c5d-4e6f-8a9b-0c1d2e3f4a5b",
      "updatedAt": "2026-10-15T09:30:00Z",
      "updatedBy": "pX1pjf3n4bGqwBx2Hc3sbT1LkG0u2",
      "workbookId": "6a5d1e2c-3b4f-4a8e-9c7d-1f2e3d4c5b6a"
    }
  ],
  "total": 1
}
```

### List teams

List the organization's teams, or find them by name. Gets one page; to see more, run it again with the next page it gives.

**Inputs**

- Name (`name`, text): Only teams with this name.
- Visibility (`visibility`, text): Whether everyone can see the team, or only its members. One of: `private` (Private (default)), `public`.
- Page size (`page_size`, number): How many to return, 1 to 1,000. Defaults to 50. From 1 to 1000.
- Next page (`page`, text): The 'next_page' from an earlier run of this step, to get the page after it.

**Outputs**

- `count` (number): How many are on this page
- `next_page` (text): Give this as 'Next page' to get the next page; empty on the last page
- `teams` (list): The teams
- `total` (number): How many there are in all

**Example output**

```json
{
  "count": 1,
  "next_page": "",
  "teams": [
    {
      "createdAt": "2026-10-15T09:30:00Z",
      "createdBy": "pX1pjf3n4bGqwBx2Hc3sbT1LkG0u2",
      "description": "The finance team.",
      "isArchived": false,
      "name": "Finance",
      "teamId": "3c4d5e6f-7a8b-4c9d-8e0f-1a2b3c4d5e6f",
      "updatedAt": "2026-10-15T09:30:00Z",
      "updatedBy": "pX1pjf3n4bGqwBx2Hc3sbT1LkG0u2",
      "visibility": "private"
    }
  ],
  "total": 1
}
```

### List workbook elements

List a workbook's elements (tables, charts, controls), or one page's, with their ids and columns, to export one of them.

**Inputs**

- Workbook (`workbook_id`, text, required): The workbook. Pick one, or give its id from an earlier step.
- Workbook page (`page_id`, text): Only this page's elements. Leave empty for all.
- Page size (`page_size`, number): How many to return, 1 to 1,000. Defaults to 50. From 1 to 1000.
- Next page (`page`, text): The 'next_page' from an earlier run of this step, to get the page after it.

**Outputs**

- `count` (number): How many are on this page
- `elements` (list): The elements
- `next_page` (text): Give this as 'Next page' to get the next page; empty on the last page
- `total` (number): How many there are in all

**Example output**

```json
{
  "count": 1,
  "elements": [
    {
      "columns": [
        "Region",
        "Revenue"
      ],
      "elementId": "xQ3a9Lm2Pz",
      "error": "",
      "name": "Sales by region",
      "type": "table",
      "vizualizationType": ""
    }
  ],
  "next_page": "",
  "total": 1
}
```

### List workbooks

List the workbooks you can see, with their links, folders and when they last changed. Gets one page; to see more, run it again with the next page it gives.

**Inputs**

- Archived only (`archived`, true/false): List archived workbooks instead.
- Page size (`page_size`, number): How many to return, 1 to 1,000. Defaults to 50. From 1 to 1000.
- Next page (`page`, text): The 'next_page' from an earlier run of this step, to get the page after it.

**Outputs**

- `count` (number): How many are on this page
- `next_page` (text): Give this as 'Next page' to get the next page; empty on the last page
- `total` (number): How many there are in all
- `workbooks` (list): The workbooks

**Example output**

```json
{
  "count": 1,
  "next_page": "",
  "total": 1,
  "workbooks": [
    {
      "createdAt": "2026-09-01T08:00:00Z",
      "createdBy": "pX1pjf3n4bGqwBx2Hc3sbT1LkG0u2",
      "description": "Sales by region, refreshed daily.",
      "isArchived": false,
      "latestVersion": 12,
      "name": "Weekly sales",
      "ownerId": "pX1pjf3n4bGqwBx2Hc3sbT1LkG0u2",
      "path": "My Documents",
      "tags": [
        {
          "isArchived": false,
          "name": "Production",
          "sourceWorkbookVersion": 11,
          "taggedWorkbookId": "7b6e2f3d-4c5a-4b9f-8d8e-2a3b4c5d6e7f",
          "versionTagId": "c1d2e3f4-0000-4a8e-9c7d-1f2e3d4c5b6a",
          "workbookTaggedAt": "2026-10-15T09:30:00Z"
        }
      ],
      "updatedAt": "2026-10-15T09:30:00Z",
      "updatedBy": "pX1pjf3n4bGqwBx2Hc3sbT1LkG0u2",
      "url": "https://app.sigmacomputing.com/acme/workbook/Weekly-sales-2NqdWzJHQ8DsLqk3hA9X1b",
      "workbookId": "6a5d1e2c-3b4f-4a8e-9c7d-1f2e3d4c5b6a",
      "workbookUrlId": "2NqdWzJHQ8DsLqk3hA9X1b"
    }
  ]
}
```

### List workspaces

List the organization's workspaces, or find them by name.

**Inputs**

- Name contains (`name`, text): Only workspaces whose name has these words.
- Page size (`page_size`, number): How many to return, 1 to 1,000. Defaults to 50. From 1 to 1000.
- Next page (`page`, text): The 'next_page' from an earlier run of this step, to get the page after it.

**Outputs**

- `count` (number): How many are on this page
- `next_page` (text): Give this as 'Next page' to get the next page; empty on the last page
- `total` (number): How many there are in all
- `workspaces` (list): The workspaces

**Example output**

```json
{
  "count": 1,
  "next_page": "",
  "total": 1,
  "workspaces": [
    {
      "createdAt": "2026-02-01T08:00:00Z",
      "createdBy": "pX1pjf3n4bGqwBx2Hc3sbT1LkG0u2",
      "name": "Finance",
      "updatedAt": "2026-10-15T09:30:00Z",
      "updatedBy": "pX1pjf3n4bGqwBx2Hc3sbT1LkG0u2",
      "workspaceId": "2a3b4c5d-6e7f-4a8b-9c0d-1e2f3a4b5c6d",
      "workspaceUrlId": "7Gh8Ij9Kl0Mn1Op2Qr3St4"
    }
  ]
}
```

### Run materialization

Materialize an element now, outside its schedule, so the data behind it is fresh. Follow it with 'Get materialization'.

**Inputs**

- Workbook (`workbook_id`, text, required): The workbook. Pick one, or give its id from an earlier step.
- Materialization schedule (`sheet_id`, text, required): The element's materialization schedule. Pick one, or give its sheetId.

**Outputs**

- `materialization_id` (text): The job's id, for 'Get materialization'
- `sheet_id` (text): The materialization schedule run
- `workbook_id` (text): The workbook

**Example output**

```json
{
  "materialization_id": "m-4f3e2d1c",
  "sheet_id": "kJ8s2Lq0Wm",
  "workbook_id": "6a5d1e2c-3b4f-4a8e-9c7d-1f2e3d4c5b6a"
}
```

### Schedule workbook export

Have Sigma email a workbook, one page or one element on a schedule (every day, weekday, week or month), to email addresses or teams.

**Inputs**

- Workbook (`workbook_id`, text, required): The workbook. Pick one, or give its id from an earlier step.
- Subject (`title`, text, required): The email's subject.
- Message (`message`, text): The email's text.
- Format (`file_format`, text, required): The file to make. A whole workbook can be PDF or Excel; a page PDF, PNG or Excel; an element any of them, including CSV and JSON. One of: `pdf`, `xlsx` (Excel (XLSX)), `csv` (CSV (one element only)), `png` (PNG image (a page or element)), `json` (JSON (one element only)), `jsonl` (JSON Lines (one element only)).
- How often (`frequency`, text, required): How often Sigma sends it. One of: `daily` (Every day), `weekdays` (Every weekday (Monday to Friday)), `weekly` (Every week), `monthly` (Every month), `custom` (Custom (a cron expression)).
- Time zone (`time_zone`, text, required): The time zone the time is in, such as America/New_York.
- Email addresses (`recipients`, list): Who to send it to. Give these, teams, or both.
- Teams (`team_ids`, list): Sigma teams to send it to.
- Time (`time_of_day`, time): What time to send it. Defaults to 09:00. Only when How often is Every day, Every weekday (Monday to Friday), Every week or Every month.
- Day of the week (`day_of_week`, text): Which day, for a weekly export. Defaults to Monday. Only when How often is Every week. One of: `1` (Monday), `2` (Tuesday), `3` (Wednesday), `4` (Thursday), `5` (Friday), `6` (Saturday), `0` (Sunday).
- Day of the month (`day_of_month`, number): Which day, 1 to 28, for a monthly export. Defaults to the 1st. Only when How often is Every month. From 1 to 28.
- Cron expression (`custom_cron`, text): Five cron fields, such as 0 8 * * 1 for 8:00 every Monday. Only when How often is Custom (a cron expression).
- Workbook page (`page_id`, text): Export only this page. Leave empty for the whole workbook.
- Element (`element_id`, text): Export only this element, such as one table. Leave empty for the whole workbook (or the page chosen).
- PDF layout (`pdf_layout`, text): Portrait or landscape, for a PDF. Defaults to portrait. One of: `portrait` (Portrait (default)), `landscape`.
- Include a link to the workbook (`include_link`, true/false): Add a link to the workbook in Sigma to the email.
- Schedule name (`export_name`, text): A name for the scheduled export in Sigma.

**Outputs**

- `schedule` (object): The scheduled export
- `schedule_id` (text): Its id, for 'Delete scheduled export'

**Example output**

```json
{
  "schedule": {
    "configV2": {
      "messageBody": "This week's numbers.",
      "notificationAttachments": [
        {
          "formatOptions": {
            "type": "PDF"
          }
        }
      ],
      "title": "Weekly sales"
    },
    "createdAt": "2026-10-15T09:30:00Z",
    "createdBy": "pX1pjf3n4bGqwBx2Hc3sbT1LkG0u2",
    "disabledAt": "",
    "disabledBy": "",
    "isSuspended": false,
    "lastUpdatedByUser": "pX1pjf3n4bGqwBx2Hc3sbT1LkG0u2",
    "ownerId": "pX1pjf3n4bGqwBx2Hc3sbT1LkG0u2",
    "schedule": {
      "cronSpec": "0 9 * * 1",
      "timezone": "America/New_York"
    },
    "scheduledNotificationId": "0e1f2a3b-4c5d-4e6f-8a9b-0c1d2e3f4a5b",
    "updatedAt": "2026-10-15T09:30:00Z",
    "updatedBy": "pX1pjf3n4bGqwBx2Hc3sbT1LkG0u2",
    "workbookId": "6a5d1e2c-3b4f-4a8e-9c7d-1f2e3d4c5b6a"
  },
  "schedule_id": "0e1f2a3b-4c5d-4e6f-8a9b-0c1d2e3f4a5b"
}
```

### Send workbook

Have Sigma email a workbook, one page or one element now, as a PDF, Excel, CSV or PNG attachment, to email addresses or Sigma teams.

**Inputs**

- Workbook (`workbook_id`, text, required): The workbook. Pick one, or give its id from an earlier step.
- Subject (`title`, text, required): The email's subject.
- Message (`message`, text): The email's text.
- Format (`file_format`, text, required): The file to make. A whole workbook can be PDF or Excel; a page PDF, PNG or Excel; an element any of them, including CSV and JSON. One of: `pdf`, `xlsx` (Excel (XLSX)), `csv` (CSV (one element only)), `png` (PNG image (a page or element)), `json` (JSON (one element only)), `jsonl` (JSON Lines (one element only)).
- Email addresses (`recipients`, list): Who to send it to. Give these, teams, or both.
- Teams (`team_ids`, list): Sigma teams to send it to.
- Workbook page (`page_id`, text): Export only this page. Leave empty for the whole workbook.
- Element (`element_id`, text): Export only this element, such as one table. Leave empty for the whole workbook (or the page chosen).
- PDF layout (`pdf_layout`, text): Portrait or landscape, for a PDF. Defaults to portrait. One of: `portrait` (Portrait (default)), `landscape`.
- Include a link to the workbook (`include_link`, true/false): Add a link to the workbook in Sigma to the email.

**Outputs**

- `recipients` (list): The addresses it went to
- `sent` (true/false): True once Sigma has taken it to send
- `team_ids` (list): The teams it went to
- `workbook_id` (text): The workbook sent

**Example output**

```json
{
  "recipients": [
    "finance@example.com"
  ],
  "sent": true,
  "team_ids": [],
  "workbook_id": "6a5d1e2c-3b4f-4a8e-9c7d-1f2e3d4c5b6a"
}
```

### Update member

Change a member's name, email, account type or kind. Only the fields given change. Needs Admin credentials.

**Inputs**

- Member (`member_id`, text, required): The member. Pick one, or give their id from an earlier step.
- First name (`first_name`, text): A new first name. Leave empty to keep it.
- Last name (`last_name`, text): A new last name. Leave empty to keep it.
- Email (`email`, text): A new email address. Leave empty to keep it.
- Account type (`account_type`, text): Their account type, such as Admin, Creator or Viewer. Leave empty for your organization's default.
- Kind of user (`user_kind`, text): An internal user, a guest from outside, or an embed user. One of: `internal` (Internal user), `guest`, `embed` (Embed user).

**Outputs**

- `member` (object): The member

**Example output**

```json
{
  "member": {
    "createdAt": "2026-09-01T08:00:00Z",
    "createdBy": "pX1pjf3n4bGqwBx2Hc3sbT1LkG0u2",
    "email": "jo@example.com",
    "firstName": "Jo",
    "homeFolderId": "9f8e7d6c-5b4a-4c3d-2e1f-0a9b8c7d6e5f",
    "isArchived": false,
    "isInactive": false,
    "lastName": "Bloggs",
    "memberId": "pX1pjf3n4bGqwBx2Hc3sbT1LkG0u2",
    "memberType": "Creator",
    "organizationId": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
    "profileImgUrl": "",
    "updatedAt": "2026-10-15T09:30:00Z",
    "updatedBy": "pX1pjf3n4bGqwBx2Hc3sbT1LkG0u2",
    "userKind": "internal"
  }
}
```
