> ## 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 smart lists

> Get all available smart lists with member counts.

Smart lists are system-generated dynamic audience segments (not user-created lists). They are computed from relationship/subscription/payment state and update automatically.

Examples include:
- `subscribers`
- `followers`
- `auto_renewing`
- `non_renewing`
- `expired_subscribers`
- `free_trial_subscribers`
- `spent_more_than_50`

For `subscribers`, the count reflects current non-deleted subscription relationships that are contactable by the requesting creator.

<Info>
  **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.
</Info>


## OpenAPI

````yaml /openapi.json get /chats/lists/smart
openapi: 3.1.0
info:
  title: Fanvue API
  version: '0.1'
servers: []
security: []
paths:
  /chats/lists/smart:
    get:
      summary: Get smart lists
      description: >-
        Get all available smart lists with member counts.


        Smart lists are system-generated dynamic audience segments (not
        user-created lists). They are computed from
        relationship/subscription/payment state and update automatically.


        Examples include:

        - `subscribers`

        - `followers`

        - `auto_renewing`

        - `non_renewing`

        - `expired_subscribers`

        - `free_trial_subscribers`

        - `spent_more_than_50`


        For `subscribers`, the count reflects current non-deleted subscription
        relationships that are contactable by the requesting creator.
      operationId: getSmartLists
      parameters:
        - $ref: '#/components/parameters/ApiVersionHeader'
      responses:
        '200':
          description: List of smart lists
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    name:
                      type: string
                      description: Display name of the smart list
                    uuid:
                      type: string
                      enum:
                        - subscribers
                        - auto_renewing
                        - non_renewing
                        - followers
                        - free_trial_subscribers
                        - expired_subscribers
                        - spent_more_than_50
                        - muted
                        - creators
                      description: Smart list unique identifier
                    count:
                      type: number
                      description: Number of members in this list
                  required:
                    - name
                    - uuid
                    - count
              example:
                - name: Subscribers
                  uuid: subscribers
                  count: 1250
                - name: Auto-renewing
                  uuid: auto_renewing
                  count: 892
                - name: Non-renewing
                  uuid: non_renewing
                  count: 358
                - name: Followers
                  uuid: followers
                  count: 2156
                - name: Free trial subscribers
                  uuid: free_trial_subscribers
                  count: 45
                - name: Expired subscribers
                  uuid: expired_subscribers
                  count: 178
                - name: Spent more than $50
                  uuid: spent_more_than_50
                  count: 423
                - name: Muted
                  uuid: muted
                  count: 12
                - name: Creators
                  uuid: creators
                  count: 100
        '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.

````