> ## 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 notifications feed
> Returns a paginated list of notifications for the authenticated user, ordered by most recent first. Optionally filter by event type.
**Polling for real-time updates? Use a webhook instead.**
If you are calling this endpoint on a schedule to detect new activity, subscribe to webhooks instead — most engagement and payment activity in this feed (messages, follows, likes, comments, subscriptions, and payments) is delivered in real time by the individual webhook events. See the full event catalogue in the [webhook documentation](https://api.fanvue.com/docs/creator/overview). Some system notifications (promotions, account health, poll results, and fan churn risk) have no webhook equivalent yet and remain available only from this endpoint.
**Required scope**
* `read:self` — Access your own user profile information, including basic account details and settings.
## OpenAPI
````yaml /openapi.json get /notifications
openapi: 3.1.0
info:
title: Fanvue API
version: '0.1'
servers: []
security: []
paths:
/notifications:
get:
summary: Get notifications feed
description: >-
Returns a paginated list of notifications for the authenticated user,
ordered by most recent first. Optionally filter by event type.
**Polling for real-time updates? Use a webhook instead.**
If you are calling this endpoint on a schedule to detect new activity, subscribe to webhooks instead — most engagement and payment activity in this feed (messages, follows, likes, comments, subscriptions, and payments) is delivered in real time by the individual webhook events. See the full event catalogue in the [webhook documentation](https://api.fanvue.com/docs/creator/overview). Some system notifications (promotions, account health, poll results, and fan churn risk) have no webhook equivalent yet and remain available only from this endpoint.
operationId: listNotifications
parameters:
- $ref: '#/components/parameters/ApiVersionHeader'
- schema:
type: integer
exclusiveMinimum: 0
maximum: 100
description: Number of results to return (default 20)
required: false
description: Number of results to return (default 20)
name: limit
in: query
- schema:
type: string
description: Cursor for pagination
required: false
description: Cursor for pagination
name: cursor
in: query
- schema:
type: integer
description: Filter notifications by event type id
required: false
description: Filter notifications by event type id
name: eventType
in: query
responses:
'200':
description: List of notifications
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
type: object
properties:
uuid:
type: string
format: uuid
createdAt:
type: string
format: date-time
eventType:
type: integer
description: >-
Numeric event id (6=post comment, 7=post like,
9=purchase, 10=new subscriber, 11=tip, 12=new
follower, 14=promotion, 19=creator promo payment,
26=account health, 27=poll closed, 28=fan churn
risk)
isRead:
type: boolean
data:
type: object
additionalProperties: {}
description: Event-specific payload. Shape varies by eventType.
originator:
type:
- object
- 'null'
properties:
uuid:
type: string
format: uuid
handle:
type: string
displayName:
type: string
avatarUrl:
type:
- string
- 'null'
isCreator:
type: boolean
required:
- uuid
- handle
- displayName
- avatarUrl
- isCreator
receiverUuid:
type: string
format: uuid
description: UUID of the user who received the notification
required:
- uuid
- createdAt
- eventType
- isRead
- data
- originator
- receiverUuid
description: Array of notifications
nextCursor:
type:
- string
- 'null'
description: Cursor for the next page, or null if none
required:
- data
- nextCursor
example:
data:
- uuid: 6c3d8b1c-9b1f-4b6e-8d77-4e8b22ff9a01
createdAt: '2026-05-22T08:30:00.000Z'
eventType: 11
isRead: false
data:
price: 500
originator:
uuid: 8a3a93e2-1c2a-4b6c-b4fd-1cdaaa6fbc11
handle: sarahmiller
displayName: Sarah Miller
avatarUrl: https://media.fanvue.com/avatars/sarahmiller.jpg
isCreator: false
receiverUuid: 2bde24e6-942b-49d4-b7b9-8d1e8eccbffb
- uuid: f1d2e3b4-aaaa-4f5b-9c1d-2c2dffe11a23
createdAt: '2026-05-21T18:12:43.000Z'
eventType: 12
isRead: true
data: {}
originator:
uuid: 21f5c1ab-7d22-4e7d-9c2b-e1c3a4f6bb22
handle: mikejohnson
displayName: Mike Johnson
avatarUrl: null
isCreator: false
receiverUuid: 2bde24e6-942b-49d4-b7b9-8d1e8eccbffb
nextCursor: eyJvZmZzZXQiOjIwfQ
'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:self
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.
````