Skip to main content
POST
Read the distinct values of a canvas filter's fie…

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

POST /v2/api/projects/:projectId/workspaces/:workspaceId/canvases/:canvasId/filters/values 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

POST /v2/api/projects/:projectId/workspaces/:workspaceId/canvases/:canvasId/filters/values 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})$

Body

application/json

POST /v2/api/projects/:projectId/workspaces/:workspaceId/canvases/:canvasId/filters/values Request body

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

filterId
string

Return values for this filter's field. Pass this or field.

field
string

Return values for this catalog field (a fieldKey from filterable-fields). Pass this or filterId.

fieldKeys
string[]

Tables picked under one column name (raw: keys from a field's tableChoices), as a filter with fieldKeys names them: values across all of them. field must be the first.

Minimum array length: 1
itemIds
string[]

For an output field, read values from these tiles only.

excludeFilterId
string

Leave this filter out of the narrowing (so a dropdown lists every value, not only the one selected).

tz
number

The viewer's UTC offset in hours. Used only when the canvas follows each viewer's own time zone; otherwise the canvas's time zone decides.

forProjectUserId
string

Project user to run the query as; their properties drive the data model's row-level security. Required with an admin credential, ignored for a project-user token.

dataModelVersion
integer

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

Required range: x <= 9007199254740991

Response

POST /v2/api/projects/:projectId/workspaces/:workspaceId/canvases/:canvasId/filters/values Positive response

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