Skip to main content
GET
List the fields a canvas filter can target — cust…

Authorizations

authorization
string
header
required

Path Parameters

projectId
string<uuid>
required

The project in the URL. The caller's project user is read from it.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
workspaceId
string<uuid>
required

GET /v2/api/projects/:projectId/workspaces/:workspaceId/canvases/:canvasId/filterable-fields Parameter

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
canvasId
string<uuid>
required

GET /v2/api/projects/:projectId/workspaces/:workspaceId/canvases/:canvasId/filterable-fields Parameter

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

Query Parameters

apiKey
string

Upsolve API key, generated under Account → Developer settings in the Upsolve Hub. Keys are user-scoped: pass organizationId alongside the key to select which org to act on.

Minimum string length: 1
organizationId
string

The ID of the organization. Required when using Supabase JWT authentication.

connectionId
string

The ID of the connection a guest has access to

dataModelVersion
integer

Published data model version to resolve fields and run queries against. Defaults to the published version.

Required range: x <= 9007199254740991
includeTableColumns
string<boolean (preprocessed)>

Also list tableColumns: every column of the tables behind the charts, one per table, with the tiles a filter on exactly that table's column reaches. Ask for it to build a custom filter.

Response

GET /v2/api/projects/:projectId/workspaces/:workspaceId/canvases/:canvasId/filterable-fields Positive response

status
string
required
Allowed value: "success"
data
object
required