Domo Component

Manage datasets, streams, users, groups, pages, and projects in Domo.

Component key: domo ·

Description

Domo is a cloud-based business intelligence platform that provides data warehousing, data pipeline functionality, and visualization capabilities. This component allows managing datasets, streams, users, groups, pages, and projects in Domo.

API Documentation

This component was built using the Domo API Reference.

Connections

OAuth 2.0 Client Credentials

key: oauth

Create a connection of type OAuth 2.0 Client Credentials to authenticate with the Domo API.

To generate a Client ID and Client Secret, follow the steps below.

Prerequisites

A Domo account with access to the Developer Portal
The Domo instance name (the part of the URL preceding domo.com -- for example, if the Domo URL is acmecompany.domo.com, the instance name is acmecompany)

Setup Steps

Navigate to the Domo Developer Portal login page
Enter the Domo instance name and user credentials when prompted
After logging in, click on the My Account dropdown and select Manage Clients
Click Create a New Client from the Manage Clients page
Submit the required information -- a newly provisioned Client ID and Client Secret will be generated and displayed on the Manage Clients page
Copy the Client ID and Client Secret values

Configure the Connection

Enter the Client ID and Client Secret obtained from the Developer Portal
For Scopes, enter the required OAuth permission scopes separated by spaces (e.g., data workflow audit buzz user account dashboard)
- Refer to the Domo API documentation for available scope information

Input	Notes	Example
Client ID	The Client Identifier of the Domo app for API authentication.
Client Secret	The Client Secret of the Domo app for API authentication.
Scopes	The space-separated OAuth permission scopes for the API.	data workflow audit buzz user account dashboard

Triggers

New and Updated Records

Checks for new and updated records in a selected Domo resource type on a configured schedule. | key: pollChangesTrigger

Input	Notes	Example
Connection	The Domo connection to use.
Resource Type	The type of resource to monitor for changes.
Show New Records	When true, includes newly created records in the results.	true
Show Updated Records	When true, includes updated records in the results. Only available for resource types that support update tracking (DataSets, Streams, Users).	true

This trigger polls the Domo API for new and updated records across a selected resource type on a scheduled basis.

How It Works

The trigger runs on the configured schedule (e.g., every 5 minutes)
It fetches all records from the selected Domo resource using paginated requests
Records are categorized as created or updated based on the tracking strategy for the selected resource type:
- Timestamp-based (DataSets, Streams, Users, Projects): records are compared against the last successful poll time using their timestamp fields
- ID-based (Groups, Pages): records are compared against the set of previously known IDs; only newly appearing records are captured as created
The trigger updates its internal state after each poll — storing either the poll timestamp or the current set of known IDs depending on the resource type

Configuration

Configure the following inputs:

Connection: The Domo connection used to authenticate API requests

Resource Type: The Domo resource to monitor. Available options:

Resource	Change Detection	Tracks New	Tracks Updated
DataSets	Timestamp (`createdAt`, `updatedAt`)	Yes	Yes
Streams	Timestamp (`createdAt`, `modifiedAt`)	Yes	Yes
Users	Timestamp (`createdAt`, `updatedAt`)	Yes	Yes
Projects	Timestamp (`createdDate` only)	Yes	No
Groups	ID-based	Yes	No
Pages	ID-based	Yes	No

Show New Records: When enabled, includes newly created records in the results. Defaults to true
Show Updated Records: When enabled, includes modified records in the results. Applies only to resource types that support update tracking (DataSets, Streams, Users). Defaults to true

Returned Data

The trigger returns an object with two arrays — created for new records and updated for modified records. For resource types without update tracking (Projects, Groups, Pages), updated is always an empty array.

Example Response

{
  "data": {
    "created": [
      {
        "id": "ds-abc123",
        "name": "Sales Report Q1",
        "createdAt": "2024-01-15T10:30:00Z",
        "updatedAt": "2024-01-15T10:30:00Z"
      }
    ],
    "updated": [
      {
        "id": "ds-xyz789",
        "name": "Marketing Dashboard",
        "createdAt": "2024-01-10T09:00:00Z",
        "updatedAt": "2024-01-16T14:22:00Z"
      }
    ]
  }
}

Notes

On the first poll, the trigger captures a baseline snapshot. No records are returned for ID-based resources (Groups, Pages) on the first execution — subsequent polls detect additions against that baseline
For timestamp-based resources, the trigger uses the poll start time as the cutoff to avoid missing records written during execution
The Domo API enforces rate limits. Consider using longer polling intervals for high-volume resources such as DataSets and Streams to avoid exhausting API quotas. Refer to the Domo API documentation for current rate limit details
A record is classified as created if its creation timestamp exceeds the last poll time. If the creation timestamp does not exceed the cutoff but the update timestamp does, the record is classified as updated

Data Sources

Select Account

Selects a Domo account. | key: accounts | type: picklist

Input	Notes	Example
Connection	The Domo connection to use.
Limit	The number of Accounts to return in the list. The default is 50 and the maximum is 500.	100
Offset	The offset of Accounts to begin the list of Accounts within the response.	0

Select Account Type

Selects a Domo account type. | key: accountTypes | type: picklist

Input	Notes	Example
Connection	The Domo connection to use.
Limit	The number of Account Types to return in the list. The default is 50 and the maximum is 500.	100
Offset	The offset of the Account Types to begin list of Account Types within the response.	0

Select DataSet

Selects a Domo DataSet. | key: selectDataSet | type: picklist

Input	Notes	Example
Connection	The Domo connection to use.
Limit	The amount of DataSets to return in the list. The default is 50 and the maximum is 50.	100
Offset	The offset of the DataSet ID to begin list of DataSets within the response.	0

{
  "result": [
    {
      "label": "Leonhard Euler Birthday Bash",
      "key": "1"
    }
  ]
}

Select Group

Selects a Domo group. | key: groups | type: picklist

Input	Notes	Example
Connection	The Domo connection to use.
Limit	The amount of groups to return in the list. The default is 50 and the maximum is 500.	100
Offset	The offset of the group ID to begin list of groups within the response.	0

Select Page

Selects a Domo page. | key: pages | type: picklist

Input	Notes	Example
Connection	The Domo connection to use.
Limit	The amount of pages to return in the list. The default is 50 and the maximum is 500.	100
Offset	The offset of the page ID to begin list of pages within the response.	0

Select Project

Selects a Domo project. | key: projects | type: picklist

Input	Notes	Example
Connection	The Domo connection to use.

Select Project List

Selects a Domo project list. | key: projectLists | type: picklist

Input	Notes	Example
Connection	The Domo connection to use.
Project ID	The unique identifier for the project.	123

Select Stream

Selects a Domo stream. | key: streams | type: picklist

Input	Notes	Example
Connection	The Domo connection to use.
Limit	The amount of Stream to return in the list. The default is 50 and the maximum is 500.	100
Offset	The offset of the Stream ID to begin list of users within the response.	0

Select Stream Execution

Selects a Domo stream execution. | key: selectStreamExecution | type: picklist

Input	Notes	Example
Connection	The Domo connection to use.
Limit	The number of Stream Executions to return in the list. The default is 50 and the maximum is 500.	100
Offset	The offset of the Stream Execution to begin list within the response.	0
Stream ID	The ID of the Stream of data being imported into a DataSet.	67890

Select Task

Selects a Domo project task. | key: selectTask | type: picklist

Input	Notes	Example
Connection	The Domo connection to use.
Limit	The number of tasks to return in the list. The default is 10 and the maximum is 50.	100
List ID	The unique identifier for the project list.	456
Offset	The offset of tasks to begin the list within the response.	0
Project ID	The unique identifier for the project.	123

Select User

Selects a Domo user. | key: selectUser | type: picklist

Input	Notes	Example
Connection	The Domo connection to use.
Limit	The amount of users to return in the list. The default is 50 and the maximum is 500.	100
Offset	The offset of the user ID to begin list of users within the response.	0

{
  "result": [
    {
      "label": "Leonhard Euler",
      "key": "27"
    }
  ]
}

Actions

Abort Stream Execution

Aborts an entire stream execution in progress. | key: abortStreamExecution

Input	Notes	Example
Connection	The Domo connection to use.
Execution ID	The unique identifier for the Stream execution. If not provided, the current Stream execution will be aborted.	12345
Stream ID	The ID of the Stream of data being imported into a DataSet.	67890

{
  "data": null
}

Add Attachment

Adds a multipart form file to a task item as an attachment. | key: addAttachment

Input	Notes	Example
Connection	The Domo connection to use.
List ID	The unique identifier for the project list.	456
Project ID	The unique identifier for the project.	123
Task ID	The unique identifier for the task within a project list.	789

{
  "data": {
    "id": 5001,
    "name": "requirements-doc.pdf",
    "mediaType": "application/pdf",
    "fileSize": 204800,
    "taskId": 2001,
    "projectId": 7,
    "uploadedBy": 87264918,
    "uploadedAt": "2024-03-22T11:00:00.000Z"
  }
}

Add User To Group

Adds a user to a group in a Domo instance. | key: addUserToGroup

Input	Notes	Example
Connection	The Domo connection to use.
Group ID	The unique identifier for the group.	871428330
User ID	The unique identifier for the Domo user.	959463190

{
  "data": null
}

Commit Stream Execution

Commits a stream execution to import the combined set of data parts that have been successfully uploaded. | key: commitStreamExecution

Input	Notes	Example
Connection	The Domo connection to use.
Execution ID	The ID of the Stream execution within the Stream	12345
Stream ID	The ID of the Stream of data being imported into a DataSet.	67890

{
  "data": {
    "id": 3,
    "startedAt": "2024-04-01T10:00:00.000Z",
    "endedAt": "2024-04-01T10:03:45.000Z",
    "currentState": "SUCCESS",
    "createdAt": "2024-04-01T10:00:00.000Z",
    "modifiedAt": "2024-04-01T10:03:45.000Z"
  }
}

Create Account

Creates a new account in a Domo instance with the specified account type properties. | key: createAccount

Input	Notes	Example
Authenticate By	The authentication method used for the account (e.g., basic, token).	basic
Connection	The Domo connection to use.
ID	The unique identifier for the resource.	123456
Name	The display name for the resource.	John Doe
Password	The password used for account authentication.
URL	The URL of the account endpoint.	https://example.com
Username	The username for account authentication.	john.doe

{
  "data": {
    "id": 10047,
    "name": "HubSpot Marketing",
    "type": {
      "id": "username-password",
      "name": "Username / Password",
      "properties": {
        "username": "api_user@example.com",
        "url": "https://api.hubspot.com",
        "authenticateBy": "token"
      }
    },
    "valid": true,
    "userId": 87264918
  }
}

Create Data Set

Creates a new DataSet in a Domo instance. | key: createDataSet

Input	Notes	Example
Columns	A JSON array defining the column schema for the DataSet, including type and name for each column.
Connection	The Domo connection to use.
Description	A summary of the DataSet contents and purpose.	Sales data for Q1 2024
Name	Name of the DataSet to create	John Doe
Rows	The total number of rows to include in the DataSet.	1000

{
  "data": {
    "id": "4405ff58-1957-45f4-b159-8e7a88cc7dcc",
    "name": "Monthly Sales Report",
    "description": "Monthly sales data aggregated by region",
    "rows": 1250,
    "columns": 5,
    "schema": {
      "columns": [
        {
          "type": "STRING",
          "name": "region"
        },
        {
          "type": "STRING",
          "name": "product"
        },
        {
          "type": "LONG",
          "name": "units_sold"
        },
        {
          "type": "DOUBLE",
          "name": "revenue"
        },
        {
          "type": "DATE",
          "name": "sale_date"
        }
      ]
    },
    "owner": {
      "id": 87264918,
      "name": "Jane Smith"
    },
    "pdpEnabled": false,
    "createdAt": "2024-01-15T08:30:00.000Z",
    "updatedAt": "2024-03-10T14:22:00.000Z"
  }
}

Create Group

Creates a new group in a Domo instance. | key: createGroup

Input	Notes	Example
Connection	The Domo connection to use.
Name	The name of the group.	John Doe

{
  "data": {
    "id": 400112,
    "name": "Analytics Team",
    "isActive": true,
    "creatorId": 87264918,
    "default": false,
    "userCount": 8,
    "memberCount": 8
  }
}

Create List

Creates a new list within a given project. | key: createList

Input	Notes	Example
Connection	The Domo connection to use.
Index	The ordered position of the list within the project. Setting this property will re-order other lists to maintain sequential order. Defaults to 1 if not provided.	1
Name	The name of the list.	John Doe
Project ID	The unique identifier for the project.	123
Type	The workflow status category for the list (e.g., TODO, WORKING_ON, COMPLETED).

{
  "data": {
    "id": 101,
    "name": "To Do",
    "type": "TODO",
    "index": 0,
    "projectId": 7
  }
}

Create Page

Creates a new page in a Domo instance. | key: createPage

Input	Notes	Example
Card ID	The ID of the card to add to the page.	["123", "456"]
Connection	The Domo connection to use.
Group ID	The ID of the group that will be given access to view the page.	["100", "200"]
Locked	When true, restricts other users the ability to make edits to page or its content.
Name	The name of the page.	John Doe
Parent ID	The unique identifier of the parent page. If provided, the page will be created as a subpage.	123456
User ID	The ID of the user that will be given access to view the page.	["959463190", "871428330"]

{
  "data": {
    "id": 1102458,
    "name": "Sales Performance Dashboard",
    "parentId": 0,
    "ownerId": 87264918,
    "locked": false,
    "collectionIds": [],
    "cardIds": [
      88012,
      88013,
      88014
    ],
    "visibility": {
      "userIds": [
        87264918,
        54320910
      ],
      "groupIds": [
        400112
      ]
    },
    "userIds": [
      87264918,
      54320910
    ],
    "groupIds": [
      400112
    ]
  }
}

Create Project

Creates a new project in a Domo instance. | key: createProject

Input	Notes	Example
Name	Body name	John Doe
Connection	The Domo connection to use.
Description	The description of the project.	Sales data for Q1 2024
Due Date	The due date for the project. Format: ISO 8601.	2024-12-31T23:59:59Z
Members	Array of user IDs that will be assigned as members of the project.	[27, 105, 93]
Member ID	User IDs of members to include in the project.	["27", "105", "93"]
Name	The name of the project.	John Doe
Public Body	When true, makes the resource publicly visible to other Domo users.
Public	When true, the project will be publicly available to other Domo users.	true

{
  "data": {
    "id": 7,
    "name": "Q2 Data Integration Initiative",
    "description": "Integrate new data sources for Q2 reporting",
    "dueDate": "2024-06-30",
    "public": false,
    "createdDate": "2024-01-20",
    "members": [
      87264918,
      54320910,
      66011234
    ]
  }
}

Create Stream

Creates a new stream and its associated DataSet in Domo. | key: createStream

Input	Notes	Example
Columns	The column schema definition for the stream DataSet, specified as a JSON array of column objects.
Connection	The Domo connection to use.
DataSet Object	The DataSet object associated with this Stream.	["id", "name", "description"]
Description	A summary of the stream DataSet contents and purpose.	Sales data for Q1 2024
Name	The display name for the resource.	John Doe
Update Method	The data import behavior.
Update Method	Update method for body.

{
  "data": {
    "id": 32,
    "dataSet": {
      "id": "4405ff58-1957-45f4-b159-8e7a88cc7dcc",
      "name": "Monthly Sales Report",
      "description": "Monthly sales data aggregated by region",
      "rows": 1250,
      "columns": 5,
      "owner": {
        "id": 87264918,
        "name": "Jane Smith"
      },
      "createdAt": "2024-01-15T08:30:00.000Z",
      "updatedAt": "2024-03-10T14:22:00.000Z",
      "pdpEnabled": false
    },
    "updateMethod": "APPEND",
    "createdAt": "2024-01-15T08:30:00.000Z",
    "modifiedAt": "2024-03-10T14:22:00.000Z"
  }
}

Create Stream Execution

Creates a new stream execution to begin uploading data to a DataSet via a stream. | key: createStreamExecution

Input	Notes	Example
Connection	The Domo connection to use.
Stream ID	The ID of the Stream.	67890

{
  "data": {
    "id": 3,
    "startedAt": "2024-04-01T10:00:00.000Z",
    "endedAt": null,
    "currentState": "ACTIVE",
    "createdAt": "2024-04-01T10:00:00.000Z",
    "modifiedAt": "2024-04-01T10:00:00.000Z"
  }
}

Create Task

Adds a task to a project list. | key: createTask

Input	Notes	Example
Connection	The Domo connection to use.
Contributors	A JSON array of user IDs assigned as contributors to the task.	[27, 105]
Description	An optional description of the task.	Sales data for Q1 2024
Due Date	The date the task is expected to be completed.	2024-12-31T23:59:59Z
List ID	The ID of the list within a project that the task belongs to.	456
Owned By	The unique identifier of the Domo user that owns the task.	959463190
Priority	The priority position of the task within the list. Setting this property re-orders other tasks to maintain sequential order. Defaults to 1 if not provided.	3
Project ID	The ID of the project that the task belongs to.	123
Tags	A JSON array of tag labels to assign to the task for categorization.	["urgent", "review"]
Task Name	A descriptive label for the task within the project list.	Complete project review
Task Object	The task object to create or update.

{
  "data": {
    "id": 2001,
    "taskName": "Connect Salesforce data source",
    "description": "Configure the Salesforce connector and map fields to the schema",
    "dueDate": "2024-05-15",
    "ownedBy": 87264918,
    "contributors": [
      54320910
    ],
    "priority": "HIGH",
    "tags": [
      "salesforce",
      "etl"
    ],
    "projectId": 7,
    "listId": 101,
    "attachmentCount": 1,
    "createdDate": "2024-02-01",
    "lastModified": "2024-03-22"
  }
}

Create User

Creates a new user in a Domo instance. | key: createUser

Input	Notes	Example
Alternate Email	The secondary email address associated with the Domo user profile.	john.doe.alternate@example.com
Connection	The Domo connection to use.
Email	The primary email address associated with the Domo user profile.	john.doe@example.com
Employee Number	The employee identification number within the organization.	23432
Locale	The locale code used to display system settings throughout the Domo application.	en_US
Location	The office location or geographic area for the user profile.	American Fork
Name	The display name for the resource.	John Doe
Phone	The primary phone number for the Domo user profile.	888-361-1078
Role	The permission level assigned to the user (Admin, Privileged, or Participant).	Admin
Send Invite	When true, sends an email invitation to the newly created user.	true
Timezone	The IANA timezone identifier used to display system times throughout the Domo application.	America/Denver
Title	The job title for the Domo user profile.	Software Engineer
User Body	The user object to create.

{
  "data": {
    "id": 87264918,
    "name": "Jane Smith",
    "email": "jane.smith@example.com",
    "alternateEmail": "jsmith@personal.com",
    "role": "Admin",
    "title": "Data Engineering Lead",
    "phone": "+1-512-555-0142",
    "location": "Austin, TX",
    "timezone": "America/Chicago",
    "locale": "en-US",
    "employeeNumber": "EMP-1042",
    "createdAt": "2022-06-15T13:00:00.000Z",
    "updatedAt": "2024-02-20T09:30:00.000Z",
    "image": "https://example.domo.com/avatar/87264918",
    "groups": [
      {
        "id": 400112,
        "name": "Analytics Team"
      }
    ],
    "active": true
  }
}

Delete Account

Deletes an account from a Domo instance. | key: deleteAccount

Input	Notes	Example
Account ID	The unique identifier for the Domo account.	12345
Connection	The Domo connection to use.

{
  "data": null
}

Delete Attachment

Permanently deletes an attachment from a task. | key: deleteAttachment

Input	Notes	Example
Attachment ID	The unique identifier for the project attachment.	67890
Connection	The Domo connection to use.
Project ID	The ID of the project that the attachment belongs to.	123
Task ID	The ID of the task that the attachment belongs to.	789

{
  "data": null
}

Delete Data Set

Permanently deletes a DataSet from a Domo instance. | key: deleteDataSet

Input	Notes	Example
Connection	The Domo connection to use.
DataSet ID	The unique identifier for the Domo DataSet.	5168da8d-1c72-4e31-ba74-f609f73071dd

{
  "data": null
}

Delete Group

Permanently deletes a group from a Domo instance. | key: deleteGroup

Input	Notes	Example
Connection	The Domo connection to use.
Group ID	The ID of the group to delete.	871428330

{
  "data": null
}

Delete List

Permanently deletes a list from a Domo instance. | key: deleteList

Input	Notes	Example
Connection	The Domo connection to use.
List ID	The unique identifier for the project list.	456
Project ID	The unique identifier for the project.	123

{
  "data": null
}

Delete Page

Permanently deletes a page from a Domo instance. | key: deletePage

Input	Notes	Example
Connection	The Domo connection to use.
Page ID	The unique identifier for the Domo page.	123456

{
  "data": null
}

Delete Project

Permanently deletes a project from a Domo instance. | key: deleteProject

Input	Notes	Example
Connection	The Domo connection to use.
Project ID	The unique identifier for the project.	123

{
  "data": null
}

Delete Stream

Deletes a stream from a Domo instance without deleting the associated DataSet. | key: deleteStream

Input	Notes	Example
Connection	The Domo connection to use.
Stream ID	The ID of the Stream to delete.	67890

{
  "data": null
}

Delete User

Permanently deletes a user from a Domo instance. | key: deleteUser

Input	Notes	Example
Connection	The Domo connection to use.
User ID	The unique identifier for the Domo user.	959463190

{
  "data": null
}

Download Attachment

Downloads an individual attachment by ID. | key: downloadAttachment

Input	Notes	Example
Attachment ID	The unique identifier for the project attachment.	67890
Connection	The Domo connection to use.
List ID	The unique identifier for the project list.	456
Project ID	The unique identifier for the project.	123
Task ID	The unique identifier for the task within a project list.	789

{
  "data": "<binary file content>"
}

Export Data From DataSet

Exports data from a DataSet in a Domo instance. | key: exportDataFromDataSet

Input	Notes	Example
Connection	The Domo connection to use.
DataSet ID	The unique identifier for the Domo DataSet.	5168da8d-1c72-4e31-ba74-f609f73071dd
File Name	The output filename for the exported CSV data.	export_data.csv
Include Header	When true, includes table header in export.

{
  "data": "region,product,units_sold,revenue,sale_date\nNorth,Widget A,150,7500.00,2024-01-01\nSouth,Widget B,200,9800.00,2024-01-01\n"
}

Get Accounts

Retrieves the details of an account type. | key: getAccounts

Input	Notes	Example
Account Type ID	The unique identifier for the Domo account type.	12345
Connection	The Domo connection to use.

{
  "data": {
    "id": "username-password",
    "name": "Username / Password",
    "authScheme": "fields",
    "fields": [
      {
        "key": "username",
        "name": "Username",
        "type": "TEXT"
      },
      {
        "key": "password",
        "name": "Password",
        "type": "SENSITIVE"
      },
      {
        "key": "url",
        "name": "URL",
        "type": "TEXT"
      },
      {
        "key": "authenticateBy",
        "name": "Authenticate By",
        "type": "TEXT"
      }
    ]
  }
}

Get Activity Log Entries

Retrieves activity log entries. | key: getActivityLogEntries

Input	Notes	Example
Connection	The Domo connection to use.
End	The end time in milliseconds for the activity log query range.	1640995200000
Limit	The maximum number of results to return (default is 50, maximum of 1000).	100
Offset	The 0-based offset position to begin retrieving results from.	0
Start	The start time in milliseconds for the activity log query range.	1609459200000
User	The unique identifier for the user to filter activity log entries by.	959463190

{
  "data": [
    {
      "userName": "Jane Smith",
      "userId": 87264918,
      "userType": "USER",
      "actionType": "DATASET_UPDATED",
      "additionalComment": "Updated schema for Monthly Sales Report",
      "eventText": "Jane Smith updated the DataSet 'Monthly Sales Report'",
      "time": 1711929600000,
      "device": "WEB",
      "browserDetails": "Chrome/123.0.0.0",
      "ipAddress": "192.168.1.45",
      "objectName": "Monthly Sales Report",
      "objectId": "4405ff58-1957-45f4-b159-8e7a88cc7dcc",
      "objectType": "DATASET"
    },
    {
      "userName": "Carlos Rivera",
      "userId": 54320910,
      "userType": "USER",
      "actionType": "USER_LOGIN",
      "additionalComment": null,
      "eventText": "Carlos Rivera logged in",
      "time": 1711915200000,
      "device": "WEB",
      "browserDetails": "Firefox/124.0",
      "ipAddress": "10.0.0.22",
      "objectName": null,
      "objectId": null,
      "objectType": null
    }
  ]
}

Get Data Set

Retrieves the details of an existing DataSet. | key: getDataSet

Input	Notes	Example
Connection	The Domo connection to use.
DataSet ID	The unique identifier for the Domo DataSet.	5168da8d-1c72-4e31-ba74-f609f73071dd

{
  "data": {
    "id": "4405ff58-1957-45f4-b159-8e7a88cc7dcc",
    "name": "Monthly Sales Report",
    "description": "Monthly sales data aggregated by region",
    "rows": 1250,
    "columns": 5,
    "schema": {
      "columns": [
        {
          "type": "STRING",
          "name": "region"
        },
        {
          "type": "STRING",
          "name": "product"
        },
        {
          "type": "LONG",
          "name": "units_sold"
        },
        {
          "type": "DOUBLE",
          "name": "revenue"
        },
        {
          "type": "DATE",
          "name": "sale_date"
        }
      ]
    },
    "owner": {
      "id": 87264918,
      "name": "Jane Smith"
    },
    "pdpEnabled": false,
    "createdAt": "2024-01-15T08:30:00.000Z",
    "updatedAt": "2024-03-10T14:22:00.000Z"
  }
}

Get Group

Retrieves the details of an existing group. | key: getGroup

Input	Notes	Example
Connection	The Domo connection to use.
Group ID	The unique identifier for the group.	871428330

{
  "data": {
    "id": 400112,
    "name": "Analytics Team",
    "isActive": true,
    "creatorId": 87264918,
    "default": false,
    "userCount": 8,
    "memberCount": 8
  }
}

Get List

Retrieves the details of an individual list given a project id and a list id. | key: getList

Input	Notes	Example
Connection	The Domo connection to use.
List ID	The unique identifier for the project list.	456
Project ID	The unique identifier for the project.	123

{
  "data": {
    "id": 101,
    "name": "To Do",
    "type": "TODO",
    "index": 0,
    "projectId": 7
  }
}

Get List Of Attachments

Retrieves all attachments belonging to a particular task. | key: getListOfAttachments

Input	Notes	Example
Connection	The Domo connection to use.
List ID	The unique identifier for the project list.	456
Project ID	The unique identifier for the project.	123
Task ID	The unique identifier for the task within a project list.	789

{
  "data": [
    {
      "id": 5001,
      "name": "requirements-doc.pdf",
      "mediaType": "application/pdf",
      "fileSize": 204800,
      "taskId": 2001,
      "projectId": 7,
      "uploadedBy": 87264918,
      "uploadedAt": "2024-03-22T11:00:00.000Z"
    },
    {
      "id": 5002,
      "name": "schema-diagram.png",
      "mediaType": "image/png",
      "fileSize": 98304,
      "taskId": 2001,
      "projectId": 7,
      "uploadedBy": 54320910,
      "uploadedAt": "2024-03-23T09:15:00.000Z"
    }
  ]
}

Get Page

Retrieves the details of an existing page. | key: getPage

Input	Notes	Example
Connection	The Domo connection to use.
Page ID	The unique identifier for the Domo page.	123456

{
  "data": {
    "id": 1102458,
    "name": "Sales Performance Dashboard",
    "parentId": 0,
    "ownerId": 87264918,
    "locked": false,
    "collectionIds": [],
    "cardIds": [
      88012,
      88013,
      88014
    ],
    "visibility": {
      "userIds": [
        87264918,
        54320910
      ],
      "groupIds": [
        400112
      ]
    },
    "userIds": [
      87264918,
      54320910
    ],
    "groupIds": [
      400112
    ]
  }
}

Get Project

Retrieves the details of an existing project by ID. | key: getProject

Input	Notes	Example
Connection	The Domo connection to use.
Project ID	The unique identifier for the project.	123

{
  "data": {
    "id": 7,
    "name": "Q2 Data Integration Initiative",
    "description": "Integrate new data sources for Q2 reporting",
    "dueDate": "2024-06-30",
    "public": false,
    "createdDate": "2024-01-20",
    "members": [
      87264918,
      54320910,
      66011234
    ]
  }
}

Get Project Members

Retrieves the member user IDs for a given project. | key: getProjectMembers

Input	Notes	Example
Connection	The Domo connection to use.
Project ID	The unique identifier for the project.	123

{
  "data": [
    87264918,
    54320910,
    66011234
  ]
}

Get Stream

Retrieves the details of an existing stream. | key: getStream

Input	Notes	Example
Connection	The Domo connection to use.
Fields	The fields to include in the response: all, id, dataset, updateMethod, createdAt, or modifiedAt.	all
Stream ID	The id of the stream.	67890

{
  "data": {
    "id": 32,
    "dataSet": {
      "id": "4405ff58-1957-45f4-b159-8e7a88cc7dcc",
      "name": "Monthly Sales Report",
      "description": "Monthly sales data aggregated by region",
      "rows": 1250,
      "columns": 5,
      "owner": {
        "id": 87264918,
        "name": "Jane Smith"
      },
      "createdAt": "2024-01-15T08:30:00.000Z",
      "updatedAt": "2024-03-10T14:22:00.000Z",
      "pdpEnabled": false
    },
    "updateMethod": "APPEND",
    "createdAt": "2024-01-15T08:30:00.000Z",
    "modifiedAt": "2024-03-10T14:22:00.000Z"
  }
}

Get Stream Execution

Retrieves the details of an existing stream execution. | key: getStreamExecution

Input	Notes	Example
Connection	The Domo connection to use.
Execution ID	The ID of the Stream execution within the Stream.	12345
Stream ID	The ID of the Stream of data being imported into a DataSet.	67890

{
  "data": {
    "id": 1,
    "startedAt": "2024-03-10T14:00:00.000Z",
    "endedAt": "2024-03-10T14:05:32.000Z",
    "currentState": "SUCCESS",
    "createdAt": "2024-03-10T14:00:00.000Z",
    "modifiedAt": "2024-03-10T14:05:32.000Z"
  }
}

Get Task

Retrieves an individual task from a given project id and list id. | key: getTask

Input	Notes	Example
Connection	The Domo connection to use.
List ID	The unique identifier for the project list.	456
Project ID	The unique identifier for the project.	123
Task ID	The unique identifier for the task within a project list.	789

{
  "data": {
    "id": 2001,
    "taskName": "Connect Salesforce data source",
    "description": "Configure the Salesforce connector and map fields to the schema",
    "dueDate": "2024-05-15",
    "ownedBy": 87264918,
    "contributors": [
      54320910
    ],
    "priority": "HIGH",
    "tags": [
      "salesforce",
      "etl"
    ],
    "projectId": 7,
    "listId": 101,
    "attachmentCount": 1,
    "createdDate": "2024-02-01",
    "lastModified": "2024-03-22"
  }
}

Get User

Retrieves the details of an existing user. | key: getUser

Input	Notes	Example
Connection	The Domo connection to use.
User ID	The unique identifier for the Domo user.	959463190

{
  "data": {
    "id": 87264918,
    "name": "Jane Smith",
    "email": "jane.smith@example.com",
    "alternateEmail": "jsmith@personal.com",
    "role": "Admin",
    "title": "Data Engineering Lead",
    "phone": "+1-512-555-0142",
    "location": "Austin, TX",
    "timezone": "America/Chicago",
    "locale": "en-US",
    "employeeNumber": "EMP-1042",
    "createdAt": "2022-06-15T13:00:00.000Z",
    "updatedAt": "2024-02-20T09:30:00.000Z",
    "image": "https://example.domo.com/avatar/87264918",
    "groups": [
      {
        "id": 400112,
        "name": "Analytics Team"
      }
    ],
    "active": true
  }
}

Import Data Into DataSet

Imports data into a DataSet in a Domo instance, replacing the existing data. | key: importDataIntoDataSet

Input	Notes	Example
Connection	The Domo connection to use.
CSV Body	The CSV-formatted data to import into the DataSet.	Name,Email John Doe,john@example.com Jane Smith,jane@example.com
DataSet ID	The unique identifier for the Domo DataSet.	5168da8d-1c72-4e31-ba74-f609f73071dd

{
  "data": null
}

List Accounts

Lists all accounts the authenticated user has permissions for. | key: listAccounts

Input	Notes	Example
Connection	The Domo connection to use.
Limit	The number of Accounts to return in the list. The default is 50 and the maximum is 500.	100
Offset	The offset of Accounts to begin the list of Accounts within the response.	0

{
  "data": [
    {
      "id": 10045,
      "name": "Salesforce Production",
      "type": {
        "id": "username-password",
        "name": "Username / Password"
      },
      "valid": true,
      "userId": 87264918
    },
    {
      "id": 10046,
      "name": "MySQL Data Warehouse",
      "type": {
        "id": "username-password",
        "name": "Username / Password"
      },
      "valid": true,
      "userId": 54320910
    }
  ]
}

List DataSets

Lists all DataSets in a Domo instance. | key: listDataSets

Input	Notes	Example
Connection	The Domo connection to use.
Limit	The amount of DataSets to return in the list. The default is 50 and the maximum is 50.	100
Name Like	A case-insensitive filter that limits the list to DataSets with names containing this string.	sales
Offset	The offset of the DataSet ID to begin list of users within the response.	0
Sort	The DataSet field to sort by. Prefix with a negative sign to reverse the sort (e.g., '-name').	name

{
  "data": [
    {
      "id": "4405ff58-1957-45f4-b159-8e7a88cc7dcc",
      "name": "Monthly Sales Report",
      "description": "Monthly sales data aggregated by region",
      "rows": 1250,
      "columns": 5,
      "schema": {
        "columns": [
          {
            "type": "STRING",
            "name": "region"
          },
          {
            "type": "STRING",
            "name": "product"
          },
          {
            "type": "LONG",
            "name": "units_sold"
          },
          {
            "type": "DOUBLE",
            "name": "revenue"
          },
          {
            "type": "DATE",
            "name": "sale_date"
          }
        ]
      },
      "owner": {
        "id": 87264918,
        "name": "Jane Smith"
      },
      "pdpEnabled": false,
      "createdAt": "2024-01-15T08:30:00.000Z",
      "updatedAt": "2024-03-10T14:22:00.000Z"
    },
    {
      "id": "7b3e8f21-3c6d-4a11-9e2f-5d8b12c45e90",
      "name": "Customer Churn Analysis",
      "description": "Weekly customer churn metrics",
      "rows": 4300,
      "columns": 8,
      "schema": {
        "columns": [
          {
            "type": "LONG",
            "name": "customer_id"
          },
          {
            "type": "STRING",
            "name": "segment"
          },
          {
            "type": "DATE",
            "name": "churn_date"
          },
          {
            "type": "DOUBLE",
            "name": "lifetime_value"
          },
          {
            "type": "STRING",
            "name": "churn_reason"
          },
          {
            "type": "STRING",
            "name": "plan_type"
          },
          {
            "type": "LONG",
            "name": "tenure_days"
          },
          {
            "type": "STRING",
            "name": "region"
          }
        ]
      },
      "owner": {
        "id": 54320910,
        "name": "Carlos Rivera"
      },
      "pdpEnabled": true,
      "createdAt": "2023-11-02T10:00:00.000Z",
      "updatedAt": "2024-03-08T09:15:00.000Z"
    }
  ]
}

List Groups

Lists all groups in a Domo instance. | key: listGroups

Input	Notes	Example
Connection	The Domo connection to use.
Limit	The amount of groups to return in the list. The default is 50 and the maximum is 500.	100
Offset	The offset of the group ID to begin list of groups within the response.	0

{
  "data": [
    {
      "id": 400112,
      "name": "Analytics Team",
      "isActive": true,
      "creatorId": 87264918,
      "default": false,
      "userCount": 8,
      "memberCount": 8
    },
    {
      "id": 400205,
      "name": "Executive Dashboard Viewers",
      "isActive": true,
      "creatorId": 87264918,
      "default": false,
      "userCount": 12,
      "memberCount": 12
    }
  ]
}

List Pages

Lists all pages in a Domo instance. | key: listPages

Input	Notes	Example
Connection	The Domo connection to use.
Limit	The amount of pages to return in the list. The default is 50 and the maximum is 500.	100
Offset	The offset of the page ID to begin list of pages within the response.	0

{
  "data": [
    {
      "id": 1102458,
      "name": "Sales Performance Dashboard",
      "parentId": 0,
      "ownerId": 87264918,
      "locked": false,
      "collectionIds": [],
      "cardIds": [
        88012,
        88013,
        88014
      ],
      "visibility": {
        "userIds": [
          87264918,
          54320910
        ],
        "groupIds": [
          400112
        ]
      },
      "userIds": [
        87264918,
        54320910
      ],
      "groupIds": [
        400112
      ]
    },
    {
      "id": 1102501,
      "name": "Executive Overview",
      "parentId": 0,
      "ownerId": 87264918,
      "locked": true,
      "collectionIds": [],
      "cardIds": [
        88100,
        88101
      ],
      "visibility": {
        "userIds": [],
        "groupIds": [
          400205
        ]
      },
      "userIds": [],
      "groupIds": [
        400205
      ]
    }
  ]
}

List Project List Tasks

Retrieves all tasks from a given project list. | key: listProjectListTasks

Input	Notes	Example
Connection	The Domo connection to use.
Limit	The maximum number of results to return (defaults to 10 with a maximum of 50).	100
List ID	The unique identifier for the project list.	456
Offset	The number of records to skip from the beginning of the result list (defaults to 0).	0
Project ID	The unique identifier for the project.	123

{
  "data": [
    {
      "id": 2001,
      "taskName": "Connect Salesforce data source",
      "description": "Configure the Salesforce connector and map fields to the schema",
      "dueDate": "2024-05-15",
      "ownedBy": 87264918,
      "contributors": [
        54320910
      ],
      "priority": "HIGH",
      "tags": [
        "salesforce",
        "etl"
      ],
      "projectId": 7,
      "listId": 101,
      "attachmentCount": 1,
      "createdDate": "2024-02-01",
      "lastModified": "2024-03-22"
    },
    {
      "id": 2002,
      "taskName": "Write DataSet transformation SQL",
      "description": "Write the SQL transformations for the new DataSet",
      "dueDate": "2024-05-20",
      "ownedBy": 54320910,
      "contributors": [
        87264918
      ],
      "priority": "MEDIUM",
      "tags": [
        "sql",
        "dataset"
      ],
      "projectId": 7,
      "listId": 101,
      "attachmentCount": 0,
      "createdDate": "2024-02-03",
      "lastModified": "2024-03-18"
    }
  ]
}

List Project Lists

Retrieves all lists available within a given project. | key: listProjectLists

Input	Notes	Example
Connection	The Domo connection to use.
Project ID	The unique identifier for the project.	123

{
  "data": [
    {
      "id": 101,
      "name": "To Do",
      "type": "TODO",
      "index": 0,
      "projectId": 7
    },
    {
      "id": 102,
      "name": "In Progress",
      "type": "ACTIVE",
      "index": 1,
      "projectId": 7
    },
    {
      "id": 103,
      "name": "Done",
      "type": "DONE",
      "index": 2,
      "projectId": 7
    }
  ]
}

List Projects

Retrieves a list of all accessible projects. | key: listProjects

Input	Notes	Example
Connection	The Domo connection to use.

{
  "data": [
    {
      "id": 7,
      "name": "Q2 Data Integration Initiative",
      "description": "Integrate new data sources for Q2 reporting",
      "dueDate": "2024-06-30",
      "public": false,
      "createdDate": "2024-01-20",
      "members": [
        87264918,
        54320910,
        66011234
      ]
    },
    {
      "id": 8,
      "name": "Customer 360 Rebuild",
      "description": "Rebuild the customer 360 dashboard with new data pipelines",
      "dueDate": "2024-09-15",
      "public": true,
      "createdDate": "2024-02-05",
      "members": [
        87264918,
        72980045
      ]
    }
  ]
}

List Stream Execution

Lists all stream executions that match the specified criteria. | key: listStreamExecution

Input	Notes	Example
Connection	The Domo connection to use.
Limit	The amount of Stream to return in the list. The default is 50 and the maximum is 500.	100
Offset	The offset of the Stream ID to begin list of users within the response.	0
Stream ID	The ID of the Stream	67890

{
  "data": [
    {
      "id": 1,
      "startedAt": "2024-03-10T14:00:00.000Z",
      "endedAt": "2024-03-10T14:05:32.000Z",
      "currentState": "SUCCESS",
      "createdAt": "2024-03-10T14:00:00.000Z",
      "modifiedAt": "2024-03-10T14:05:32.000Z"
    },
    {
      "id": 2,
      "startedAt": "2024-03-11T14:00:00.000Z",
      "endedAt": "2024-03-11T14:04:10.000Z",
      "currentState": "SUCCESS",
      "createdAt": "2024-03-11T14:00:00.000Z",
      "modifiedAt": "2024-03-11T14:04:10.000Z"
    }
  ]
}

List Streams

Lists all streams the authenticated user has view permissions for. | key: listStreams

Input	Notes	Example
Connection	The Domo connection to use.
Limit	The amount of Stream to return in the list. The default is 50 and the maximum is 500.	100
Offset	The offset of the Stream ID to begin list of users within the response.	0

{
  "data": [
    {
      "id": 32,
      "dataSet": {
        "id": "4405ff58-1957-45f4-b159-8e7a88cc7dcc",
        "name": "Monthly Sales Report",
        "description": "Monthly sales data aggregated by region",
        "rows": 1250,
        "columns": 5,
        "owner": {
          "id": 87264918,
          "name": "Jane Smith"
        },
        "createdAt": "2024-01-15T08:30:00.000Z",
        "updatedAt": "2024-03-10T14:22:00.000Z",
        "pdpEnabled": false
      },
      "updateMethod": "APPEND",
      "createdAt": "2024-01-15T08:30:00.000Z",
      "modifiedAt": "2024-03-10T14:22:00.000Z"
    },
    {
      "id": 45,
      "dataSet": {
        "id": "7b3e8f21-3c6d-4a11-9e2f-5d8b12c45e90",
        "name": "Customer Churn Analysis",
        "description": "Weekly customer churn metrics",
        "rows": 4300,
        "columns": 8,
        "owner": {
          "id": 54320910,
          "name": "Carlos Rivera"
        },
        "createdAt": "2023-11-02T10:00:00.000Z",
        "updatedAt": "2024-03-08T09:15:00.000Z",
        "pdpEnabled": true
      },
      "updateMethod": "REPLACE",
      "createdAt": "2023-11-02T10:00:00.000Z",
      "modifiedAt": "2024-03-08T09:15:00.000Z"
    }
  ]
}

List Users

Lists all users in a Domo instance. | key: listUsers

Input	Notes	Example
Connection	The Domo connection to use.
Limit	The amount of users to return in the list. The default is 50 and the maximum is 500.	100
Offset	The offset of the user ID to begin list of users within the response.	0

{
  "data": [
    {
      "id": 87264918,
      "name": "Jane Smith",
      "email": "jane.smith@example.com",
      "alternateEmail": "jsmith@personal.com",
      "role": "Admin",
      "title": "Data Engineering Lead",
      "phone": "+1-512-555-0142",
      "location": "Austin, TX",
      "timezone": "America/Chicago",
      "locale": "en-US",
      "employeeNumber": "EMP-1042",
      "createdAt": "2022-06-15T13:00:00.000Z",
      "updatedAt": "2024-02-20T09:30:00.000Z",
      "image": "https://example.domo.com/avatar/87264918",
      "groups": [
        {
          "id": 400112,
          "name": "Analytics Team"
        }
      ],
      "active": true
    },
    {
      "id": 54320910,
      "name": "Carlos Rivera",
      "email": "carlos.rivera@example.com",
      "alternateEmail": null,
      "role": "Participant",
      "title": "Business Analyst",
      "phone": "+1-737-555-0185",
      "location": "Denver, CO",
      "timezone": "America/Denver",
      "locale": "en-US",
      "employeeNumber": "EMP-2078",
      "createdAt": "2023-01-10T08:00:00.000Z",
      "updatedAt": "2024-01-05T16:45:00.000Z",
      "image": null,
      "groups": [],
      "active": true
    }
  ]
}

List Users In Group

Lists the users in a group in a Domo instance. | key: listUsersInGroup

Input	Notes	Example
Connection	The Domo connection to use.
Group ID	The unique identifier for the group.	871428330
Limit	The amount of groups to return in the list. The default is 50 and the maximum is 500.	100
Offset	The offset of the group ID to begin list of groups within the response.	0

Query Data Set

Queries the data in an existing Domo DataSet. | key: queryDataSet

Input	Notes	Example
Connection	The Domo connection to use.
DataSet ID	The unique identifier for the Domo DataSet.	5168da8d-1c72-4e31-ba74-f609f73071dd
SQL	The SQL query to run against the DataSet.	SELECT * FROM dataset WHERE status = 'active'

{
  "data": {
    "datasource": "4405ff58-1957-45f4-b159-8e7a88cc7dcc",
    "columns": [
      "region",
      "product",
      "units_sold"
    ],
    "metadata": [
      {
        "type": "STRING",
        "dataSourceId": "4405ff58-1957-45f4-b159-8e7a88cc7dcc",
        "maxLength": 0,
        "minLength": 0,
        "periodIndex": -1,
        "name": "region"
      },
      {
        "type": "STRING",
        "dataSourceId": "4405ff58-1957-45f4-b159-8e7a88cc7dcc",
        "maxLength": 0,
        "minLength": 0,
        "periodIndex": -1,
        "name": "product"
      },
      {
        "type": "LONG",
        "dataSourceId": "4405ff58-1957-45f4-b159-8e7a88cc7dcc",
        "maxLength": 0,
        "minLength": 0,
        "periodIndex": -1,
        "name": "units_sold"
      }
    ],
    "rows": [
      [
        "North",
        "Widget A",
        150
      ],
      [
        "South",
        "Widget B",
        200
      ],
      [
        "East",
        "Widget C",
        175
      ]
    ],
    "numRows": 3,
    "numColumns": 3,
    "fromcache": false
  }
}

Raw Request

Sends a raw HTTP request to the Domo API. | key: rawRequest

Input	Notes	Example
Connection	The Domo connection to use.
Data	The HTTP body payload to send to the URL.	{"exampleKey": "Example Data"}
File Data	File Data to be sent as a multipart form upload.	[{key: "example.txt", value: "My File Contents"}]
File Data File Names	File names to apply to the file data inputs. Keys must match the file data keys above.
Form Data	The Form Data to be sent as a multipart form upload.	[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header	A list of headers to send with the request.	User-Agent: curl/7.64.1
Max Retry Count	The maximum number of retries to attempt. Specify 0 for no retries.	0
Method	The HTTP method to use.
Query Parameter	A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Response Type	The type of data you expect in the response. You can request json, text, or binary data.	json
Retry On All Errors	If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.	false
Retry Delay (ms)	The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.	0
Timeout	The maximum time that a client will await a response to its request	2000
URL	This is the URL to call.	/datasets
Use Exponential Backoff	Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.	false

{
  "data": {
    "statusCode": 200,
    "headers": {
      "content-type": "application/json;charset=UTF-8",
      "x-domo-sdk-version": "1"
    },
    "body": {
      "id": "4405ff58-1957-45f4-b159-8e7a88cc7dcc",
      "name": "Monthly Sales Report",
      "rows": 1250
    }
  }
}

Remove User From Group

Removes a user from a group in a Domo instance. | key: removeUserFromGroup

Input	Notes	Example
Connection	The Domo connection to use.
Group ID	The unique identifier for the group.	871428330
User ID	The unique identifier for the Domo user.	959463190

{
  "data": null
}

Search Stream

Searches for streams that match the specified criteria. | key: searchStream

Input	Notes	Example
Connection	The Domo connection to use.
Fields	The fields to include in the response: all, id, dataset, updateMethod, createdAt, or modifiedAt.	all
Qualifiers	The search qualifier expression to filter streams (e.g., dataSource.id or dataSource.owner.id).	dataSource.id:123

{
  "data": [
    {
      "id": 32,
      "dataSet": {
        "id": "4405ff58-1957-45f4-b159-8e7a88cc7dcc",
        "name": "Monthly Sales Report",
        "description": "Monthly sales data aggregated by region",
        "rows": 1250,
        "columns": 5,
        "owner": {
          "id": 87264918,
          "name": "Jane Smith"
        },
        "createdAt": "2024-01-15T08:30:00.000Z",
        "updatedAt": "2024-03-10T14:22:00.000Z",
        "pdpEnabled": false
      },
      "updateMethod": "APPEND",
      "createdAt": "2024-01-15T08:30:00.000Z",
      "modifiedAt": "2024-03-10T14:22:00.000Z"
    },
    {
      "id": 45,
      "dataSet": {
        "id": "7b3e8f21-3c6d-4a11-9e2f-5d8b12c45e90",
        "name": "Customer Churn Analysis",
        "description": "Weekly customer churn metrics",
        "rows": 4300,
        "columns": 8,
        "owner": {
          "id": 54320910,
          "name": "Carlos Rivera"
        },
        "createdAt": "2023-11-02T10:00:00.000Z",
        "updatedAt": "2024-03-08T09:15:00.000Z",
        "pdpEnabled": true
      },
      "updateMethod": "REPLACE",
      "createdAt": "2023-11-02T10:00:00.000Z",
      "modifiedAt": "2024-03-08T09:15:00.000Z"
    }
  ]
}

Share Account

Shares an account with one or more users. | key: shareAccount

Input	Notes	Example
Account ID	The ID of the Account.	12345
Connection	The Domo connection to use.
User	The User to share the Account with.	["959463190", "871428330"]

{
  "data": null
}

Update Account

Updates the specified account's metadata and type properties. | key: updateAccount

Input	Notes	Example
Account ID	The ID of the account to update.	12345
Connection	The Domo connection to use.
Update Account Body	The account object to update.

{
  "data": {
    "id": 10047,
    "name": "HubSpot Marketing (Updated)",
    "type": {
      "id": "username-password",
      "name": "Username / Password",
      "properties": {
        "username": "api_user@example.com",
        "url": "https://api.hubspot.com",
        "authenticateBy": "token"
      }
    },
    "valid": true,
    "userId": 87264918
  }
}

Update Data Set

Updates the specified DataSet's metadata. | key: updateDataSet

Input	Notes	Example
Connection	The Domo connection to use.
DataSet ID	The unique identifier for the Domo DataSet.	5168da8d-1c72-4e31-ba74-f609f73071dd
Update DataSet Body	The DataSet object to update.

{
  "data": {
    "id": "4405ff58-1957-45f4-b159-8e7a88cc7dcc",
    "name": "Monthly Sales Report (Updated)",
    "description": "Monthly sales data aggregated by region",
    "rows": 1250,
    "columns": 5,
    "schema": {
      "columns": [
        {
          "type": "STRING",
          "name": "region"
        },
        {
          "type": "STRING",
          "name": "product"
        },
        {
          "type": "LONG",
          "name": "units_sold"
        },
        {
          "type": "DOUBLE",
          "name": "revenue"
        },
        {
          "type": "DATE",
          "name": "sale_date"
        }
      ]
    },
    "owner": {
      "id": 87264918,
      "name": "Jane Smith"
    },
    "pdpEnabled": false,
    "createdAt": "2024-01-15T08:30:00.000Z",
    "updatedAt": "2024-04-01T11:00:00.000Z"
  }
}

Update Group

Updates the specified group's attributes in a Domo instance. | key: updateGroup

Input	Notes	Example
Connection	The Domo connection to use.
Group ID	The unique identifier for the group.	871428330
Update Group Body	The group object to update.

{
  "data": {
    "id": 400112,
    "name": "Analytics Team (Updated)",
    "isActive": true,
    "creatorId": 87264918,
    "default": false,
    "userCount": 8,
    "memberCount": 8
  }
}

Update List

Updates the details of a list within a project. | key: updateList

Input	Notes	Example
Connection	The Domo connection to use.
Index	The updated index of the list within the project. Updating the index of a list may also change the order of the other lists in the project to remain sequential.	1
List ID	The unique identifier for the project list.	456
Name	The updated name of the list.	John Doe
Project ID	The unique identifier for the project.	123
Type	The workflow status category for the list (e.g., TODO, WORKING_ON, COMPLETED).
Update List Body	The list object to update.

{
  "data": {
    "id": 101,
    "name": "Backlog",
    "type": "TODO",
    "index": 0,
    "projectId": 7
  }
}

Update Page

Updates the specified page's attributes in a Domo instance. | key: updatePage

Input	Notes	Example
Connection	The Domo connection to use.
Page ID	The unique identifier for the Domo page.	123456
Update Page Body	The page object to update.

{
  "data": {
    "id": 1102458,
    "name": "Sales Performance Dashboard (Updated)",
    "parentId": 0,
    "ownerId": 87264918,
    "locked": true,
    "collectionIds": [],
    "cardIds": [
      88012,
      88013,
      88014
    ],
    "visibility": {
      "userIds": [
        87264918,
        54320910
      ],
      "groupIds": [
        400112
      ]
    },
    "userIds": [
      87264918,
      54320910
    ],
    "groupIds": [
      400112
    ]
  }
}

Update Project

Updates attributes of an existing project in a Domo instance. | key: updateProject

Input	Notes	Example
Connection	The Domo connection to use.
Description	Updates the description of the project.	Sales data for Q1 2024
Due Date	Updates the due date of the project.	2024-12-31T23:59:59Z
Name	Updates the name of the project.	John Doe
Project ID	The unique identifier for the project.	123
Public	Updates whether or not the project is publicly available to Domo users.
Update Project Body	The project object to update.

Update Project Members

Updates the members of a given project. | key: updateProjectMembers

Input	Notes	Example
Connection	The Domo connection to use.
Project ID	The unique identifier for the project.	123
Update Project Members Body	Array of user IDs to assign as members of the project.

{
  "data": null
}

Update Stream

Updates the specified stream's metadata. | key: updateStream

Input	Notes	Example
Connection	The Domo connection to use.
Stream ID	The ID of the stream to update.	67890
Update Method Body	The update method configuration.
Update Method	The data import behavior.	REPLACE

{
  "data": {
    "id": 32,
    "dataSet": {
      "id": "4405ff58-1957-45f4-b159-8e7a88cc7dcc",
      "name": "Monthly Sales Report",
      "description": "Monthly sales data aggregated by region",
      "rows": 1250,
      "columns": 5,
      "owner": {
        "id": 87264918,
        "name": "Jane Smith"
      },
      "createdAt": "2024-01-15T08:30:00.000Z",
      "updatedAt": "2024-03-10T14:22:00.000Z",
      "pdpEnabled": false
    },
    "updateMethod": "REPLACE",
    "createdAt": "2024-01-15T08:30:00.000Z",
    "modifiedAt": "2024-04-01T10:00:00.000Z"
  }
}

Update Task

Updates the details of a task within a project list. | key: updateTask

Input	Notes	Example
Connection	The Domo connection to use.
Contributors	A JSON array of user IDs assigned as contributors to the task.	[27, 105]
Description	A summary of the DataSet contents and purpose.	Sales data for Q1 2024
Due Date	The due date for the project. Format: ISO 8601.	2024-12-31T23:59:59Z
List ID	The unique identifier for the project list.	456
Owned By	The unique identifier of the Domo user that owns the task.	959463190
Priority	The priority position of the task within the list. Setting this property re-orders other tasks to maintain sequential order. Defaults to 1 if not provided.	3
Project ID	The unique identifier for the project.	123
Tags	A JSON array of tag labels to assign to the task for categorization.	["urgent", "review"]
Task ID	The unique identifier for the task within a project list.	789
Task Name	A descriptive label for the task within the project list.	Complete project review
Update Task Body	The task object to update.

{
  "data": {
    "id": 2001,
    "taskName": "Connect Salesforce data source (Updated)",
    "description": "Configure the Salesforce connector and map fields to the schema",
    "dueDate": "2024-05-15",
    "ownedBy": 87264918,
    "contributors": [
      54320910
    ],
    "priority": "CRITICAL",
    "tags": [
      "salesforce",
      "etl"
    ],
    "projectId": 7,
    "listId": 101,
    "attachmentCount": 1,
    "createdDate": "2024-02-01",
    "lastModified": "2024-04-01"
  }
}

Update User

Updates the specified user's attributes in a Domo instance. | key: updateUser

Input	Notes	Example
Alternate Email	The secondary email address associated with the Domo user profile.	john.doe.alternate@example.com
Connection	The Domo connection to use.
Email	The primary email address associated with the Domo user profile.	john.doe@example.com
Employee Number	The employee identification number within the organization.	23432
Locale	The locale code used to display system settings throughout the Domo application.	en_US
Location	The office location or geographic area for the user profile.	American Fork
Name	User's full name	John Doe
Phone	The primary phone number for the Domo user profile.	888-361-1078
Role	The system role of the user	Admin
Roled	The unique identifier for the custom or system role assigned to the user.	123
Timezone	The IANA timezone identifier used to display system times throughout the Domo application.	America/Denver
Title	The job title for the Domo user profile.	Software Engineer
Update User Body	The user object to update.
User ID	The unique identifier for the Domo user.	959463190

{
  "data": {
    "id": 87264918,
    "name": "Jane Smith",
    "email": "jane.smith@example.com",
    "alternateEmail": "jsmith@personal.com",
    "role": "Admin",
    "title": "Senior Data Engineering Lead",
    "phone": "+1-512-555-0142",
    "location": "Austin, TX",
    "timezone": "America/Chicago",
    "locale": "en-US",
    "employeeNumber": "EMP-1042",
    "createdAt": "2022-06-15T13:00:00.000Z",
    "updatedAt": "2024-04-01T10:00:00.000Z",
    "image": "https://example.domo.com/avatar/87264918",
    "groups": [
      {
        "id": 400112,
        "name": "Analytics Team"
      }
    ],
    "active": true
  }
}

Upload Data Part

Uploads a data part within a stream execution to add rows to the DataSet. | key: uploadDataPart

Input	Notes	Example
Connection	The Domo connection to use.
Execution ID	The ID of the Stream execution within the Stream.	12345
Part ID	The ID of the data part being used to upload a subset of data within the Stream execution.	1
Stream ID	The ID of the Stream of data being imported into a DataSet.	67890

{
  "data": null
}

Changelog

2026-04-10

Updated Example Payloads

2026-04-08

Added New and Updated Records polling trigger for monitoring new and updated records across Domo resource types including DataSets, Streams, Users, Projects, Groups, and Pages with automatic change detection

2026-04-07

Added global debug support across all actions for improved troubleshooting

2026-03-31

Various modernizations and documentation updates

2026-03-05

Added inline data sources for stream executions, tasks, users, DataSets, accounts, account types, groups, pages, projects, project lists, and streams to enhance data selection capabilities

Manage datasets, streams, users, groups, pages, and projects in Domo.

Description​

API Documentation​

Connections​

OAuth 2.0 Client Credentials​

Prerequisites​

Setup Steps​

Configure the Connection​

Triggers​

New and Updated Records​

How It Works​

Configuration​

Returned Data​

Notes​

Data Sources​

Select Account​

Select Account Type​

Select DataSet​

Select Group​

Select Page​

Select Project​

Select Project List​

Select Stream​

Select Stream Execution​

Select Task​

Select User​

Actions​

Abort Stream Execution​

Add Attachment​

Add User To Group​

Commit Stream Execution​

Create Account​

Create Data Set​

Create Group​

Create List​

Create Page​

Create Project​

Create Stream​

Create Stream Execution​

Create Task​

Create User​

Delete Account​

Delete Attachment​

Delete Data Set​

Delete Group​

Delete List​

Delete Page​

Delete Project​

Delete Stream​

Delete User​

Download Attachment​

Export Data From DataSet​

Get Accounts​

Get Activity Log Entries​

Get Data Set​

Get Group​

Get List​

Get List Of Attachments​

Get Page​

Get Project​

Get Project Members​

Get Stream​

Get Stream Execution​

Get Task​

Get User​

Import Data Into DataSet​

List Accounts​

List DataSets​

List Groups​

List Pages​

List Project List Tasks​

List Project Lists​

List Projects​

List Stream Execution​

List Streams​

List Users​

List Users In Group​

Query Data Set​

Raw Request​

Remove User From Group​