> ## Documentation Index
> Fetch the complete documentation index at: https://docs.upsolve.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List Canvas Filter Values

> Read the distinct values of a canvas filter's field (or of a catalog field) from its own source



## OpenAPI

````yaml post /v2/api/projects/{projectId}/workspaces/{workspaceId}/canvases/{canvasId}/filters/values
openapi: 3.1.0
info:
  title: Upsolve API
  version: 1.5.0
servers:
  - url: https://api.upsolve.ai
security: []
tags: []
paths:
  /v2/api/projects/{projectId}/workspaces/{workspaceId}/canvases/{canvasId}/filters/values:
    post:
      summary: Read the distinct values of a canvas filter's fie…
      description: >-
        Read the distinct values of a canvas filter's field (or of a catalog
        field) from its own source
      operationId: >-
        PostV2ApiProjectsProjectIdWorkspacesWorkspaceIdCanvasesCanvasIdFiltersValues
      parameters:
        - name: projectId
          in: path
          required: true
          description: The project in the URL. The caller's project user is read from it.
          schema:
            type: string
            format: uuid
            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})$
            description: The project in the URL. The caller's project user is read from it.
        - name: workspaceId
          in: path
          required: true
          description: >-
            POST
            /v2/api/projects/:projectId/workspaces/:workspaceId/canvases/:canvasId/filters/values
            Parameter
          schema:
            type: string
            format: uuid
            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})$
        - name: canvasId
          in: path
          required: true
          description: >-
            POST
            /v2/api/projects/:projectId/workspaces/:workspaceId/canvases/:canvasId/filters/values
            Parameter
          schema:
            type: string
            format: uuid
            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})$
      requestBody:
        description: >-
          POST
          /v2/api/projects/:projectId/workspaces/:workspaceId/canvases/:canvasId/filters/values
          Request body
        content:
          application/json:
            schema:
              type: object
              properties:
                apiKey:
                  description: >-
                    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.
                  type: string
                  minLength: 1
                organizationId:
                  type: string
                  description: >-
                    The ID of the organization. Required when using Supabase JWT
                    authentication.
                connectionId:
                  type: string
                  description: The ID of the connection a guest has access to
                filterId:
                  description: Return values for this filter's field. Pass this or `field`.
                  type: string
                field:
                  description: >-
                    Return values for this catalog field (a `fieldKey` from
                    filterable-fields). Pass this or `filterId`.
                  type: string
                fieldKeys:
                  description: >-
                    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.
                  minItems: 1
                  type: array
                  items:
                    type: string
                itemIds:
                  description: For an output field, read values from these tiles only.
                  type: array
                  items:
                    type: string
                excludeFilterId:
                  description: >-
                    Leave this filter out of the narrowing (so a dropdown lists
                    every value, not only the one selected).
                  type: string
                tz:
                  description: >-
                    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.
                  type: number
                forProjectUserId:
                  description: >-
                    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.
                  type: string
                dataModelVersion:
                  description: >-
                    Published data model version to resolve fields and run
                    queries against. Defaults to the published version.
                  type: integer
                  exclusiveMinimum: 0
                  maximum: 9007199254740991
              required: []
      responses:
        '200':
          description: >-
            POST
            /v2/api/projects/:projectId/workspaces/:workspaceId/canvases/:canvasId/filters/values
            Positive response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    const: success
                  data:
                    type: object
                    properties:
                      values:
                        type: array
                        items:
                          type: string
                        description: Distinct values of the field, at most 1000.
                      error:
                        description: Why the values could not be read, when they could not.
                        type: string
                    required:
                      - values
                    additionalProperties: false
                required:
                  - status
                  - data
                additionalProperties: false
        '400':
          description: >-
            POST
            /v2/api/projects/:projectId/workspaces/:workspaceId/canvases/:canvasId/filters/values
            Negative response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    const: error
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      code:
                        type: string
                      details:
                        type: object
                        propertyNames:
                          type: string
                        additionalProperties: {}
                    required:
                      - message
                    additionalProperties: false
                required:
                  - status
                  - error
                additionalProperties: false
      security:
        - APIKEY_3: []
components:
  securitySchemes:
    APIKEY_3:
      type: apiKey
      in: header
      name: authorization

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.