Supported Endpoints
Summary of Content
Connections
Connection Paths
Connection Grants
Workbooks
Datasets
Dataset Materialization
Queries
Teams
Organization Members
Workspaces
Workspace Grants
Who Am I?
Connections
GET /v2/connections/{connectionId}
Returns a connection object based on the input connectionId. Learn more
PATCH /v2/connections/{connectionId}
Returns the updated connection object. Learn more
Connection Paths
GET /v2/connections/paths
Returns an object that includes a list of "entries". Each entry is a connection path object.
Learn more
POST /v2/connection/{connectionId}/lookup
Returns an object that includes the inodeId associated with the requested warehouse connection path. Learn more
Connection Grants
POST /v2/connections
Use this endpoint to create a data warehouse connection object. Learn more.
GET /v2/connections?limit=<number>&page=<page-string>
Returns a list the active data warehouse connection object.
GET /v2/connections/{connectionId}
Returns a connection object based on the input connectionId. Learn more.
PUT /v2/connections/:id
This endpoint allows you to update or restore a connection object to a data warehouse. Learn more.
GET /v2/connections/:connectionId/test
Use this endpoint to validate a data warehouse connection object. Learn more.
DELETE /v2/connections/:connectionId
Use this endpoint to delete a data warehouse connection object. Learn more.
Workbooks
GET /v2/workbooks
Returns a list of available workbooks. Learn more
GET /v2/workbooks/{workbookId}
Returns a workbook object based on a unique workbook identifier, workbookId. Learn more
GET /v2/workbooks/{workbookId}/schema
Returns a workbook schema object based on a workbookId. Learn more
POST /v2/workbooks/{workbookId}/export
Returns a workbook schema object based on a workbookId. Learn more
Datasets
GET /v2/datasets
Returns a list of datasets in your organization. Learn more
GET /v2/datasets/{datasetId}
Returns a dataset object based on its unique identifier, datasetId. Learn more
Dataset Materialization
GET /v2/datasets/{datasetId}/materialization
Returns a list of materializations for the dataset. Learn more
POST /v2/datasets/{datasetId}/materialization
Initiates a new materialization of the specified dataset. Learn more
Queries
GET /v2/query/{queryId}/download
Downloads the result of a successful query. Learn more
Teams
GET /v2/teams
Returns a list of teams in your organization. Learn more
GET /v2/teams/{teamId}
Returns a team object based on its unique identifier, teamId. Learn more
POST /v2/teams
Creates a new team, and returns a team object. Learn more
PATCH /v2/teams/{teamId}
Updates the team's metadata and returns the associated team object. Learn more
PATCH /v2/teams/{teamId}/members
Based on the entered parameters, adds or removes team members. Returns an empty object. Learn more
DELETE /v2/teams/{teamId}
Deletes a team based on the provided unique identifier, teamId. Returns an empty object. Learn more
POST /v2/user-attributes/{userAttributeId}/teams
Assigns a user attribute to a team. Before you use this endpoint, you must create user attributes in the UI. For more information, see User Attributes.
Organization Members
GET /v2/members
Returns a list of members in your organization. Learn more
GET /v2/members/{memberId}
Returns a member object based on its unique identifier, memberId. Learn more
POST /v2/members
Sends an invite to your soon-to-be new organization member. Returns an object containing a unique identifier (memberId) associated with the new user. Learn more
PATCH /v2/members/{memberId}
Updates a user's attributes based on its unique identifier, memberId, and the request body. Returns the associated member object. Learn more
DELETE /v2/members/{memberId}
Deactivates a user based on its unique identifier, memberId. Returns an empty object. Learn more
Workspaces
GET /v2/workspaces
Returns a list workspaces in the organization. Learn more
GET /v2/workspaces/{workspaceId}
Returns a workspace’s metadata. Learn more
POST /v2/workspaces
Creates a new workspace. Returns a workspace object.
Learn more
PATCH /v2/workspaces/{workspaceId}
Update the workspace’s metadata. Returns a workspace object.
Learn more
DELETE /v2/workspaces/{workspaceId}
Deletes the workspace. Returns an empty object. Learn more
Workspace Grants
GET /v2/workspaces/{workspaceId}/grants
Returns a list grants associated with the requested workspace. Learn more
POST /v2/workspaces/{workspaceId}/grants
Creates and/or updates a workspace's grants. Returns an empty object. Learn more
DELETE /v2/workspaces/{workspaceId}/grants/{grantId}
Revokes an existing grant. Returns an empty object. Learn more
Who Am I?
GET /v2/whoami
Returns an object identifying the current authenticated user’s id and organization. Learn more