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

# Get dynamic smart list dimensions

> Dynamic smart lists are user-created, filter-defined audience segments — distinct from the read-only, system-generated `/lists/smart` cohorts (`subscribers`, `followers`, etc.) and from the static, manually-curated `/lists/custom` lists. A dynamic smart list's membership is computed from a stored filter definition over relationship, spend, engagement, and memory dimensions, and is re-evaluated on read. Spend condition values are in USD cents (e.g. `5000` for $50).

This resource requires the account's dynamic smart list builder to be enabled; a 403 response means it is not.

Returns the manifest of filterable dimensions available for building a dynamic smart list definition.

> [!NOTE]
>
> **Required scopes**
>
> * `read:chat` — Read chat conversations, messages, and chat-related data. This includes viewing chat lists and message history.
> * `read:fan` — Access fan-related data and information within the platform.


## OpenAPI

````yaml /openapi-v1.json get /v1/chats/lists/dynamic/dimensions
openapi: 3.1.0
info:
  title: Fanvue API
  version: '0.1'
servers:
  - url: https://api.fanvue.com
security: []
paths:
  /v1/chats/lists/dynamic/dimensions:
    get:
      summary: Get dynamic smart list dimensions
      description: >-
        Dynamic smart lists are user-created, filter-defined audience segments —
        distinct from the read-only, system-generated `/lists/smart` cohorts
        (`subscribers`, `followers`, etc.) and from the static, manually-curated
        `/lists/custom` lists. A dynamic smart list's membership is computed
        from a stored filter definition over relationship, spend, engagement,
        and memory dimensions, and is re-evaluated on read. Spend condition
        values are in USD cents (e.g. `5000` for $50).


        This resource requires the account's dynamic smart list builder to be
        enabled; a 403 response means it is not.


        Returns the manifest of filterable dimensions available for building a
        dynamic smart list definition.
      operationId: getDynamicSmartListDimensions
      parameters:
        - $ref: '#/components/parameters/ApiVersionHeader'
      responses:
        '200':
          description: Dimension manifest
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    key:
                      type: string
                    labelKey:
                      type: string
                    category:
                      type: string
                    valueType:
                      type: string
                    operators:
                      type: array
                      items:
                        type: string
                    store:
                      type: string
                    enumOptions:
                      type: array
                      items:
                        type: object
                        properties:
                          value:
                            type: string
                          labelKey:
                            type: string
                          aliases:
                            type: array
                            items:
                              type: string
                        required:
                          - value
                          - labelKey
                      description: Other stored values this option also represents
                    maxValue:
                      type: number
                      description: >-
                        Largest value the builder accepts (seconds for time
                        windows); on money dimensions this caps the optional
                        withinSeconds and olderThanSeconds windows
                    withinSecondsPresets:
                      type: array
                      items:
                        type: number
                      description: >-
                        Rolling window choices (seconds) for count_within_days
                        dimensions
                    supportsMinAmount:
                      type: boolean
                      description: >-
                        Whether this recency dimension also accepts { seconds,
                        minAmount }
                    supportsAllTime:
                      type: boolean
                      description: >-
                        Whether the window may be left out, meaning all time: {
                        count } on count_within_days, { minAmount,
                        amountOperator? } on days dimensions with
                        supportsMinAmount
                  required:
                    - key
                    - labelKey
                    - category
                    - valueType
                    - operators
                    - store
                  additionalProperties: {}
                  description: >-
                    A filterable dimension the builder can render a condition
                    row for
              example:
                - key: total_spent
                  labelKey: smartLists.dimension.totalSpent
                  category: spend
                  valueType: number
                  operators:
                    - gte
                    - lte
                    - between
                  store: postgres
        '400':
          description: Bad Request - API version not supported OR validation failed
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/UnsupportedVersionError'
                  - $ref: '#/components/schemas/ValidationError'
        '401':
          $ref: '#/components/responses/UnauthorizedResponse'
        '403':
          $ref: '#/components/responses/UnauthorizedResponse'
        '410':
          $ref: '#/components/responses/SunsetVersionResponse'
        '429':
          $ref: '#/components/responses/RateLimitResponse'
      security:
        - BearerAuth:
            - read:chat
            - read:fan
components:
  parameters:
    ApiVersionHeader:
      name: X-Fanvue-API-Version
      in: header
      required: true
      schema:
        type: string
        default: '2025-06-26'
        example: '2025-06-26'
      description: API version to use for the request
  schemas:
    UnsupportedVersionError:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
      required:
        - error
        - message
      description: API version not supported
    ValidationError:
      type: object
      properties:
        errors:
          type: array
          items:
            type: string
      required:
        - errors
      description: Request validation failed
  responses:
    UnauthorizedResponse:
      description: Unauthorized Response
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
            required:
              - error
    SunsetVersionResponse:
      description: API version no longer supported (sunset)
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
              message:
                type: string
              nextVersion:
                type: string
            required:
              - error
              - message
    RateLimitResponse:
      description: Too many requests - rate limit exceeded
      headers:
        Retry-After:
          description: Number of seconds to wait before retrying the request
          schema:
            type: integer
        X-RateLimit-Limit:
          description: The maximum number of requests allowed in the current window
          schema:
            type: integer
        X-RateLimit-Remaining:
          description: The number of requests remaining in the current window
          schema:
            type: integer
        X-RateLimit-Reset:
          description: The Unix timestamp (seconds) when the rate limit window resets
          schema:
            type: integer
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
            required:
              - error
  securitySchemes:
    BearerAuth:
      type: oauth2
      description: >-
        OAuth 2.0 access token, presented as a JWT bearer token in the
        `Authorization` header. Obtain a token via the authorization-code flow;
        the scopes granted to the token determine which operations it may call.
      flows:
        authorizationCode:
          authorizationUrl: https://auth.fanvue.com/oauth2/auth
          tokenUrl: https://auth.fanvue.com/oauth2/token
          refreshUrl: https://auth.fanvue.com/oauth2/token
          scopes:
            read:self: >-
              Access your own user profile information, including basic account
              details and settings.
            read:chat: >-
              Read chat conversations, messages, and chat-related data. This
              includes viewing chat lists and message history.
            write:chat: >-
              Create new chats and send messages. This scope is required for any
              chat-related actions that modify data.
            read:experience: >-
              Exchange a fan's experience token for the resolved experience and
              the fan's identity, so an embedded fan-facing experience can
              render the right content.
            write:experience: >-
              Request that the creator publish or unpublish a fan-facing
              experience. The app mints a request token; the creator confirms
              and Fanvue performs the change.
            read:fan: Access fan-related data and information within the platform.
            read:post: Read posts, including post details, comments, likes, and tips.
            write:post: Create, edit, and manage posts and content on behalf of users.
            read:media: Access media files, images, videos, and other content assets.
            write:media: >-
              Upload, modify, and manage media files and content assets. Also
              required for vault folder management.
            read:creator: >-
              Access creator profiles, content, and creator-specific
              information.
            write:creator: Modify creator profiles, settings, and creator-specific data.
            read:insights: >-
              Access analytics, metrics, and insights data for performance
              tracking.
            read:tracking_links: >-
              Read tracking links and the users associated with them, including
              per-user tracking metadata.
            write:tracking_links: Create and delete tracking links.
            read:agency: Read agency information, including the agency's team members.
            write:agency: >-
              Manage agency team members and invites, including inviting new
              team members and creators.

````

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