API Data Provider - Online Help

Hive Tables

The provider models the data in API into a list of tables that can be queried using standard SQL statements.

Generally, querying API tables is the same as querying a table in a relational database. Sometimes there are special cases, for example, including a certain column in the WHERE clause might be required to get data for certain columns in the table. This is typically needed for situations where a separate request must be made for each row to get certain columns. These types of situations are clearly documented at the top of the table page linked below.

Hive Tables

Name Description
ActionComments Returns all comments for a given action
Actions Returns all actions for a given workspace that the user has access to
ActionTemplates Returns all action templates for a given workspace that the user has access to
CustomTags Returns all project or user custom tags
Groups Returns all chat groups for a given workspace
Labels Returns all labels for a given workspace that the user has access to
Projects Returns all projects for a given workspace that the user has access to
ProjectTags Returns all project tags for a workspace and projectId
RoleTags Returns all role tags for a workspace
Teams Returns all teams for your workspace
Users Returns a list of users or a specific user
UserSettings Returns a single user setting for a given workspace and user
UserTags Returns all user tags for a user in a workspace
Workspaces Returns all workspaces that you're a member of
WorkspaceUsers Returns all users for a given workspace that the user has access to

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8487.0