Reusable SQL query definitions and team assignment.
GET
/me/queriesList my queries
Returns all queries that the current user can access based on their team memberships.
Includes team associations for each query in the normalized response.
Parameters
limitinteger
limit
The maximum number of items to list.
Type
integer
Format
"int32"Minimum
0Maximum
100Default
100pageinteger
page
The page number to retrieve (1-indexed). Used with limit to support offset-based pagination.
Type
integer
Format
"int32"Minimum
1Default
1sortBystring
sortBy
The field to sort by.
Type
string
Valid values
"name""updatedAt"Default
"updatedAt"sortDirectionstring
sortDirection
The direction to sort (ascending or descending).
Type
string
Valid values
"asc""desc"Default
"asc"Responses
Responses
A list of queries the current user can access is returned.
application/json
JSON "total": 0, "items": [ { "queryId": "A1B2C3D4E5", "teamIds": [ "A1B2C3D4E5" ], "catalogId": "A1B2C3D4E5", "jobIds": [ "A1B2C3D4E5" ] } ], "included": { "queries": [ { "id": "A1B2C3D4E5", "memberId": "A1B2C3D4E5", "name": "Daily Sales Summary", "description": "Daily ETL pipeline for sales data", "catalog_schema": "analytics", "catalogId": "A1B2C3D4E5", "queryText": "SELECT region, SUM(amount) FROM sales GROUP BY region", "tags": [ [ "etl", "sales", "daily" ] ], "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5" } ], "catalogs": [ { "id": "A1B2C3D4E5", "name": "Production Cluster", "provider": "glue", "config": { "initialDatabase": "default", "initialDatabaseComment": "Default in-memory database for development" }, "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5" } ], "teams": [ { "team": { "id": "A1B2C3D4E5", "organizationId": "A1B2C3D4E5", "name": "string", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5", "defaultRoleId": "A1B2C3D4E5" }, "memberCount": 0 } ], "jobs": [ { "id": "A1B2C3D4E5", "memberId": "A1B2C3D4E5", "jobKey": "daily-sales-etl", "version": 3, "currentVersion": 3, "draftVersion": 4, "basedOnVersion": 0, "status": "active", "clusterId": "A1B2C3D4E5", "description": "Daily ETL pipeline for sales data", "config": { "sql": { "source": "string", "queryId": "Q1R2S3T4U5" }, "python": { "source": "string", "packageName": "string", "entryPoint": "string", "parameters": [ [ "--name=job", "one", "two" ] ], "namedParameters": { "additionalProperties": "string" } }, "compute": { "driver": { "instanceType": "c8g.2xlarge", "ebsConfig": { "volumeType": "gp3", "volumeSize": 100, "iops": 3000, "throughput": 125, "deleteOnTermination": true } }, "worker": { "instanceType": "c8g.4xlarge", "ebsConfig": { "volumeType": "gp3", "volumeSize": 100, "iops": 3000, "throughput": 125, "deleteOnTermination": true }, "maxNodes": 4, "capacityType": "on-demand" } }, "lakesail": { "executionMode": "standalone", "maxRetries": 3, "lakesailImageUri": "string", "libraries": [ { "pypi": { "package": "string", "repo": "string" }, "requirements": { "source": "string", "uri": "string" }, "whl": "string" } ], "additionalProperties": "string" } }, "timeoutSeconds": 3600, "sourceConfig": { "url": "https://github.com/acme/data-pipelines.git", "provider": "string", "reference": { "type": "string", "value": "main" }, "snapshotCommit": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2" }, "dependsOn": [ { "jobKey": "A1B2C3D4E5" } ], "cronExpression": "0 2 * * *", "cronTimezone": "America/New_York", "concurrencyPolicy": "skip", "maxConcurrentRuns": 1, "missedSchedulePolicy": "latest", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "nextRunAt": "string", "lastScheduledAt": "string", "updatedBy": "A1B2C3D4E5" } ] }
{
}
GET
/workloads/queriesList queries
Returns a paginated list of all queries in the organization, including their SQL statements and catalog configuration.
Parameters
limitinteger
limit
The maximum number of items to list.
Type
integer
Format
"int32"Minimum
0Maximum
100Default
100Responses
Responses
A list of queries is returned.
application/json
JSON "total": 0, "items": [ { "queryId": "A1B2C3D4E5", "teamIds": [ "A1B2C3D4E5" ], "catalogId": "A1B2C3D4E5", "jobIds": [ "A1B2C3D4E5" ] } ], "included": { "queries": [ { "id": "A1B2C3D4E5", "memberId": "A1B2C3D4E5", "name": "Daily Sales Summary", "description": "Daily ETL pipeline for sales data", "catalog_schema": "analytics", "catalogId": "A1B2C3D4E5", "queryText": "SELECT region, SUM(amount) FROM sales GROUP BY region", "tags": [ [ "etl", "sales", "daily" ] ], "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5" } ], "catalogs": [ { "id": "A1B2C3D4E5", "name": "Production Cluster", "provider": "glue", "config": { "initialDatabase": "default", "initialDatabaseComment": "Default in-memory database for development" }, "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5" } ], "teams": [ { "team": { "id": "A1B2C3D4E5", "organizationId": "A1B2C3D4E5", "name": "string", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5", "defaultRoleId": "A1B2C3D4E5" }, "memberCount": 0 } ], "jobs": [ { "id": "A1B2C3D4E5", "memberId": "A1B2C3D4E5", "jobKey": "daily-sales-etl", "version": 3, "currentVersion": 3, "draftVersion": 4, "basedOnVersion": 0, "status": "active", "clusterId": "A1B2C3D4E5", "description": "Daily ETL pipeline for sales data", "config": { "sql": { "source": "string", "queryId": "Q1R2S3T4U5" }, "python": { "source": "string", "packageName": "string", "entryPoint": "string", "parameters": [ [ "--name=job", "one", "two" ] ], "namedParameters": { "additionalProperties": "string" } }, "compute": { "driver": { "instanceType": "c8g.2xlarge", "ebsConfig": { "volumeType": "gp3", "volumeSize": 100, "iops": 3000, "throughput": 125, "deleteOnTermination": true } }, "worker": { "instanceType": "c8g.4xlarge", "ebsConfig": { "volumeType": "gp3", "volumeSize": 100, "iops": 3000, "throughput": 125, "deleteOnTermination": true }, "maxNodes": 4, "capacityType": "on-demand" } }, "lakesail": { "executionMode": "standalone", "maxRetries": 3, "lakesailImageUri": "string", "libraries": [ { "pypi": { "package": "string", "repo": "string" }, "requirements": { "source": "string", "uri": "string" }, "whl": "string" } ], "additionalProperties": "string" } }, "timeoutSeconds": 3600, "sourceConfig": { "url": "https://github.com/acme/data-pipelines.git", "provider": "string", "reference": { "type": "string", "value": "main" }, "snapshotCommit": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2" }, "dependsOn": [ { "jobKey": "A1B2C3D4E5" } ], "cronExpression": "0 2 * * *", "cronTimezone": "America/New_York", "concurrencyPolicy": "skip", "maxConcurrentRuns": 1, "missedSchedulePolicy": "latest", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "nextRunAt": "string", "lastScheduledAt": "string", "updatedBy": "A1B2C3D4E5" } ] }
{
}
POST
/workloads/queriesCreate a query
Defines a new reusable SQL query within the organization. Queries can be referenced by one or more jobs and shared with teams for collaborative use.
Request Body
application/json
JSON "name": "Daily Sales Summary", "description": "Daily ETL pipeline for sales data", "catalog_schema": "analytics", "catalogId": "A1B2C3D4E5", "queryText": "SELECT region, SUM(amount) FROM sales GROUP BY region", "tags": [ [ "etl", "sales", "daily" ] ], "teamIds": [ "A1B2C3D4E5" ]
{
}
Responses
Responses
The query was created successfully.
application/json
JSON "id": "A1B2C3D4E5", "memberId": "A1B2C3D4E5", "name": "Daily Sales Summary", "description": "Daily ETL pipeline for sales data", "catalog_schema": "analytics", "catalogId": "A1B2C3D4E5", "queryText": "SELECT region, SUM(amount) FROM sales GROUP BY region", "tags": [ [ "etl", "sales", "daily" ] ], "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5"
{
}
GET
/workloads/queries/{query}Describe a query
Returns the full details of a query, including its SQL statement, catalog provider, schema, and associated teams.
Parameters
queryrequired
query*
A query ID.
Required
Responses
Responses
Query details with normalized entity references.
application/json
JSON "item": { "queryId": "A1B2C3D4E5", "teamIds": [ "A1B2C3D4E5" ], "catalogId": "A1B2C3D4E5", "jobIds": [ "A1B2C3D4E5" ] }, "included": { "queries": [ { "id": "A1B2C3D4E5", "memberId": "A1B2C3D4E5", "name": "Daily Sales Summary", "description": "Daily ETL pipeline for sales data", "catalog_schema": "analytics", "catalogId": "A1B2C3D4E5", "queryText": "SELECT region, SUM(amount) FROM sales GROUP BY region", "tags": [ [ "etl", "sales", "daily" ] ], "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5" } ], "catalogs": [ { "id": "A1B2C3D4E5", "name": "Production Cluster", "provider": "glue", "config": { "initialDatabase": "default", "initialDatabaseComment": "Default in-memory database for development" }, "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5" } ], "teams": [ { "team": { "id": "A1B2C3D4E5", "organizationId": "A1B2C3D4E5", "name": "string", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5", "defaultRoleId": "A1B2C3D4E5" }, "memberCount": 0 } ], "jobs": [ { "id": "A1B2C3D4E5", "memberId": "A1B2C3D4E5", "jobKey": "daily-sales-etl", "version": 3, "currentVersion": 3, "draftVersion": 4, "basedOnVersion": 0, "status": "active", "clusterId": "A1B2C3D4E5", "description": "Daily ETL pipeline for sales data", "config": { "sql": { "source": "string", "queryId": "Q1R2S3T4U5" }, "python": { "source": "string", "packageName": "string", "entryPoint": "string", "parameters": [ [ "--name=job", "one", "two" ] ], "namedParameters": { "additionalProperties": "string" } }, "compute": { "driver": { "instanceType": "c8g.2xlarge", "ebsConfig": { "volumeType": "gp3", "volumeSize": 100, "iops": 3000, "throughput": 125, "deleteOnTermination": true } }, "worker": { "instanceType": "c8g.4xlarge", "ebsConfig": { "volumeType": "gp3", "volumeSize": 100, "iops": 3000, "throughput": 125, "deleteOnTermination": true }, "maxNodes": 4, "capacityType": "on-demand" } }, "lakesail": { "executionMode": "standalone", "maxRetries": 3, "lakesailImageUri": "string", "libraries": [ { "pypi": { "package": "string", "repo": "string" }, "requirements": { "source": "string", "uri": "string" }, "whl": "string" } ], "additionalProperties": "string" } }, "timeoutSeconds": 3600, "sourceConfig": { "url": "https://github.com/acme/data-pipelines.git", "provider": "string", "reference": { "type": "string", "value": "main" }, "snapshotCommit": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2" }, "dependsOn": [ { "jobKey": "A1B2C3D4E5" } ], "cronExpression": "0 2 * * *", "cronTimezone": "America/New_York", "concurrencyPolicy": "skip", "maxConcurrentRuns": 1, "missedSchedulePolicy": "latest", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "nextRunAt": "string", "lastScheduledAt": "string", "updatedBy": "A1B2C3D4E5" } ] }
{
}
DELETE
/workloads/queries/{query}Delete a query
Permanently removes a query and its team assignments. Queries that are still referenced by active jobs cannot be deleted.
Parameters
queryrequired
query*
A query ID.
Required
Responses
Responses
The requested operation was done successfully.
PATCH
/workloads/queries/{query}Update a query
Modifies a query's properties such as its name, SQL statement, catalog provider, or schema configuration.
Parameters
queryrequired
query*
A query ID.
Required
Request Body
application/json
JSON "name": "Daily Sales Summary", "description": "Daily ETL pipeline for sales data", "catalog_schema": "analytics", "catalogId": "A1B2C3D4E5", "queryText": "SELECT region, SUM(amount) FROM sales GROUP BY region", "tags": [ [ "etl", "sales", "daily" ] ]
{
}
Responses
Responses
The query was updated successfully.
application/json
JSON "id": "A1B2C3D4E5", "memberId": "A1B2C3D4E5", "name": "Daily Sales Summary", "description": "Daily ETL pipeline for sales data", "catalog_schema": "analytics", "catalogId": "A1B2C3D4E5", "queryText": "SELECT region, SUM(amount) FROM sales GROUP BY region", "tags": [ [ "etl", "sales", "daily" ] ], "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5"
{
}
GET
/workloads/queries/{query}/teamsList query teams
Returns the teams that have been granted access to the specified query.
Parameters
limitinteger
limit
The maximum number of items to list.
Type
integer
Format
"int32"Minimum
0Maximum
100Default
100Responses
Responses
The list of teams associated with the query is returned.
application/json
JSON "total": 0, "items": [ { "team": { "id": "A1B2C3D4E5", "organizationId": "A1B2C3D4E5", "name": "string", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5", "defaultRoleId": "A1B2C3D4E5" }, "memberCount": 0 } ]
{
}
POST
/workloads/queries/{query}/teamsAdd teams to a query
Grants one or more teams access to a query. Team members inherit the ability to view and use the query based on their team role permissions.
Parameters
queryrequired
query*
A query ID.
Required
Request Body
application/json
JSON "teamIds": [ "A1B2C3D4E5" ]
{
}
Responses
Responses
The teams were added to the query successfully.
application/json
JSON "items": [ { "queryId": "A1B2C3D4E5", "teamId": "A1B2C3D4E5", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5" } ]
{
}
DELETE
/workloads/queries/{query}/teams/{team}Remove a team from a query
Revokes a team's access to a query. Team members will no longer be able to view or use the query unless they have access through another team.
Parameters
queryrequired
query*
A query ID.
Required
teamrequired
team*
The team ID.
Required
Responses
Responses
The team was removed from the query successfully.
GET
/workloads/teams/{team}/queriesList team queries
Returns a paginated list of queries that the specified team has been granted access to.
Parameters
limitinteger
limit
The maximum number of items to list.
Type
integer
Format
"int32"Minimum
0Maximum
100Default
100Responses
Responses
A list of queries accessible to the team is returned.
application/json
JSON "total": 0, "items": [ { "queryId": "A1B2C3D4E5", "teamIds": [ "A1B2C3D4E5" ], "catalogId": "A1B2C3D4E5", "jobIds": [ "A1B2C3D4E5" ] } ], "included": { "queries": [ { "id": "A1B2C3D4E5", "memberId": "A1B2C3D4E5", "name": "Daily Sales Summary", "description": "Daily ETL pipeline for sales data", "catalog_schema": "analytics", "catalogId": "A1B2C3D4E5", "queryText": "SELECT region, SUM(amount) FROM sales GROUP BY region", "tags": [ [ "etl", "sales", "daily" ] ], "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5" } ], "catalogs": [ { "id": "A1B2C3D4E5", "name": "Production Cluster", "provider": "glue", "config": { "initialDatabase": "default", "initialDatabaseComment": "Default in-memory database for development" }, "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5" } ], "teams": [ { "team": { "id": "A1B2C3D4E5", "organizationId": "A1B2C3D4E5", "name": "string", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5", "defaultRoleId": "A1B2C3D4E5" }, "memberCount": 0 } ], "jobs": [ { "id": "A1B2C3D4E5", "memberId": "A1B2C3D4E5", "jobKey": "daily-sales-etl", "version": 3, "currentVersion": 3, "draftVersion": 4, "basedOnVersion": 0, "status": "active", "clusterId": "A1B2C3D4E5", "description": "Daily ETL pipeline for sales data", "config": { "sql": { "source": "string", "queryId": "Q1R2S3T4U5" }, "python": { "source": "string", "packageName": "string", "entryPoint": "string", "parameters": [ [ "--name=job", "one", "two" ] ], "namedParameters": { "additionalProperties": "string" } }, "compute": { "driver": { "instanceType": "c8g.2xlarge", "ebsConfig": { "volumeType": "gp3", "volumeSize": 100, "iops": 3000, "throughput": 125, "deleteOnTermination": true } }, "worker": { "instanceType": "c8g.4xlarge", "ebsConfig": { "volumeType": "gp3", "volumeSize": 100, "iops": 3000, "throughput": 125, "deleteOnTermination": true }, "maxNodes": 4, "capacityType": "on-demand" } }, "lakesail": { "executionMode": "standalone", "maxRetries": 3, "lakesailImageUri": "string", "libraries": [ { "pypi": { "package": "string", "repo": "string" }, "requirements": { "source": "string", "uri": "string" }, "whl": "string" } ], "additionalProperties": "string" } }, "timeoutSeconds": 3600, "sourceConfig": { "url": "https://github.com/acme/data-pipelines.git", "provider": "string", "reference": { "type": "string", "value": "main" }, "snapshotCommit": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2" }, "dependsOn": [ { "jobKey": "A1B2C3D4E5" } ], "cronExpression": "0 2 * * *", "cronTimezone": "America/New_York", "concurrencyPolicy": "skip", "maxConcurrentRuns": 1, "missedSchedulePolicy": "latest", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "nextRunAt": "string", "lastScheduledAt": "string", "updatedBy": "A1B2C3D4E5" } ] }
{
}