> ## 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.

# List automated messages

> Returns the per-trigger state of the authenticated creator's automated messages. All triggers are always listed; disabled triggers have `enabled: false` and null content fields.

<Info>
  **Required scope**

  * `read:creator` — Access creator profiles, content, and creator-specific information.
</Info>


## OpenAPI

````yaml /openapi.json get /chats/automated-messages
openapi: 3.1.0
info:
  title: Fanvue API
  version: '0.1'
servers: []
security: []
paths:
  /chats/automated-messages:
    get:
      summary: List automated messages
      description: >-
        Returns the per-trigger state of the authenticated creator's automated
        messages. All triggers are always listed; disabled triggers have
        `enabled: false` and null content fields.
      operationId: listAutomatedMessages
      parameters:
        - $ref: '#/components/parameters/ApiVersionHeader'
      responses:
        '200':
          description: Per-trigger automated message state
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        trigger:
                          type: string
                          enum:
                            - new_subscriber
                            - new_follower
                            - subscription_canceled
                            - re_subscribed
                            - renewed
                            - new_purchase
                            - first_message_reply
                          description: >-
                            Event that sends the automated message:
                            new_subscriber, new_follower, subscription_canceled
                            (subscriber cancels auto-renew), re_subscribed,
                            renewed (subscription renews), new_purchase, or
                            first_message_reply (fan messages the creator for
                            the first time)
                        enabled:
                          type: boolean
                          description: >-
                            Whether an automated message is active for this
                            trigger
                        text:
                          type:
                            - string
                            - 'null'
                          description: >-
                            Message text content (null when disabled or
                            media-only)
                        price:
                          type:
                            - number
                            - 'null'
                          description: >-
                            Pay-to-view price in cents (null when disabled or
                            unpriced)
                        mediaUuids:
                          type: array
                          items:
                            type: string
                            format: uuid
                          description: >-
                            Ordered list of media UUIDs attached to the message
                            (empty when disabled)
                        mediaPreviewUuid:
                          type:
                            - string
                            - 'null'
                          format: uuid
                          description: >-
                            UUID of the free preview media, or null when none is
                            set
                        updatedAt:
                          type:
                            - string
                            - 'null'
                          format: date-time
                          description: >-
                            When the automated message was last configured (null
                            when disabled)
                      required:
                        - trigger
                        - enabled
                        - text
                        - price
                        - mediaUuids
                        - mediaPreviewUuid
                        - updatedAt
                    description: Per-trigger state for all automated message triggers
                required:
                  - data
              example:
                data:
                  - trigger: new_subscriber
                    enabled: true
                    text: >-
                      Hey! Thanks for subscribing! Check out my latest exclusive
                      content 🔥
                    price: 999
                    mediaUuids:
                      - 7c9e6679-7425-40de-944b-e07fc1f90ae7
                    mediaPreviewUuid: 8d9e6679-7425-40de-944b-e07fc1f90ae8
                    updatedAt: '2026-07-01T12:00:00.000Z'
                  - trigger: new_follower
                    enabled: true
                    text: Thanks for the follow! 💝
                    price: null
                    mediaUuids: []
                    mediaPreviewUuid: null
                    updatedAt: '2026-06-15T09:30:00.000Z'
                  - trigger: subscription_canceled
                    enabled: false
                    text: null
                    price: null
                    mediaUuids: []
                    mediaPreviewUuid: null
                    updatedAt: null
                  - trigger: re_subscribed
                    enabled: false
                    text: null
                    price: null
                    mediaUuids: []
                    mediaPreviewUuid: null
                    updatedAt: null
                  - trigger: renewed
                    enabled: false
                    text: null
                    price: null
                    mediaUuids: []
                    mediaPreviewUuid: null
                    updatedAt: null
                  - trigger: new_purchase
                    enabled: false
                    text: null
                    price: null
                    mediaUuids: []
                    mediaPreviewUuid: null
                    updatedAt: null
                  - trigger: first_message_reply
                    enabled: false
                    text: null
                    price: null
                    mediaUuids: []
                    mediaPreviewUuid: null
                    updatedAt: null
        '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:creator
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.

````