---
title: "GET /v1/notifications"
method: GET
path: "/v1/notifications"
tags: ["notifications"]
---

# GET /v1/notifications

`GET /v1/notifications`

## Query parameters

- `_` 'cuts' | 'game_outcome' | 'game_played' | 'leaderboard_points' | 'user_demotion' | 'user_promotion' | 'user_achievement'
- `types` NotificationTypes[]
- `resetCount` boolean
- `asc` boolean
- `start` string
- `limit` number

## Response `200`

Read or Unread Notifications

- NotificationsListEntity
  - `next` string
  - `items` NotificationDto[], required
    - `type` 'cuts' | 'game_outcome' | 'game_played' | 'leaderboard_points' | 'user_demotion' | 'user_promotion' | 'user_achievement', required
    - `notification` union, required
      - CutsNotification
        - `type` 'free_gift' | 'host_cut' | 'referrer_cut' | 'parent_cut' | 'transaction_voided' | 'game_played' | 'game_outcome' | 'pending_outcome' | 'purchase' | 'redeem' | 'refund' | 'payout' | 'admin_update' | 'distributor_cut' | 'achievement', required
        - `gameId` string, required
        - `blackTickets` number, required
        - `whiteTickets` number, required
        - `isFinalResult` boolean, required
        - `isCanceled` boolean, required
        - `funds` Fund[], required
          - `type` 'free' | 'white' | 'black' | 'gray' | 'coin' | 'pending_coin' | 'point', required
          - `amount` number, required
        - `creatorId` string, required
      - GameOutcomeNotification
        - `side` 'A' | 'B', required
        - `ticketType` 'white' | 'black' | 'free', required
        - `state` 'waiting_for_match' | 'matched' | 'declared_winner' | 'declared_loser' | 'won' | 'lost' | 'canceled', required
        - `id` string, required
        - `gameId` string, required
        - `quantity` number, required
        - `matched` number, required
        - `outcomeChanged` boolean, required
        - `funds` Fund[], required
          - `type` 'free' | 'white' | 'black' | 'gray' | 'coin' | 'pending_coin' | 'point', required
          - `amount` number, required
      - GamePlayedNotification
        - `side` 'A' | 'B', required
        - `ticketType` 'white' | 'black' | 'free', required
        - `id` string, required
        - `gameId` string, required
        - `quantity` number, required
      - LeaderboardPointsNotification
        - `id` string, required
        - `leaderboardId` string, required
        - `userId` string, required
        - `points` number, required
      - UserDemotionNotification
        - `userId` string, required
      - UserPromotionNotification
        - `userId` string, required
        - `fromLeague` 'level1' | 'level2' | 'level3' | 'level4', required
        - `toLeague` 'level1' | 'level2' | 'level3' | 'level4', required
      - UserAchievementNotification
        - `userId` string, required
        - `achievementId` string, required
    - `id` string, required
    - `userId` string, required
    - `createdAt` string, date-time, required
  - `gameEntities` Game[], required
    - `audioUrl` string, required
    - `videoUrls` VideoUrls, required
      - `hls` string, required
      - `mp4360` string, required
      - `mp4540` string, required
      - `mp4720` string, required
      - `poster` string, required
    - `questionVideoUrls` VideoUrls, required
      - `hls` string, required
      - `mp4360` string, required
      - `mp4540` string, required
      - `mp4720` string, required
      - `poster` string, required
    - `landscapeVideoUrls` VideoUrls, required
      - `hls` string, required
      - `mp4360` string, required
      - `mp4540` string, required
      - `mp4720` string, required
      - `poster` string, required
    - `resultUrls` VideoUrls, required
      - `hls` string, required
      - `mp4360` string, required
      - `mp4540` string, required
      - `mp4720` string, required
      - `poster` string, required
    - `state` 'new' | 'active' | 'waiting_for_declaration' | 'declaring_winner' | 'winner_declared' | 'changing_game_result' | 'processing_payouts' | 'ended' | 'canceled' | 'refunded' | 'quarantined', required
    - `language` 'en-us' | 'es-mx', required
    - `gameType` 'POLL' | 'PREDICTION' | 'INSTANT_POLL' | 'TRIVIA' | 'SURVEY' | 'THIS_THAT', required
    - `orientation` 'landscape' | 'portrait'
    - `correctAnswer` 'A' | 'B'
    - `id` string, required
    - `creatorId` string, required
    - `creator` Creator, required
      - `avatar` string, required
      - `id` string, required
      - `partnerName` string, required
      - `avatarAssetId` string, required
      - `profileColor` string, required
      - `userName` string, required
      - `createdAt` string, date-time, required
      - `updatedAt` string, date-time, required
    - `startTime` string, date-time, required
    - `endTime` string, date-time, required
    - `lastJoinTime` string, date-time, required
    - `gameTitle` string, required
    - `sourceUrl` string, required
    - `sideA` string, required
    - `sideB` string, required
    - `videoAssetId` string
    - `questionVideoAssetId` string
    - `landscapeVideoAssetId` string
    - `audioAssetId` string
    - `resultAssetId` string
    - `text` string, required
    - `categoryId` string, required
    - `category` Category, required
      - `language` 'en-us' | 'es-mx', required
      - `id` string, required
      - `categoryName` string, required
      - `createdAt` string, required
      - `updatedAt` string, required
      - `deletedAt` string, required
      - `sticker` string
      - `icon` string
    - `isAd` boolean, required
    - `isPrivate` boolean
    - `bingSearch` string
    - `bingSearchClaim` string
    - `metadata` object
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `version` number, required
    - `urls` string[]
  - `userEntities` Profile[], required
    - `avatar` string, required
    - `id` string, required
    - `username` string, required
    - `avatarAssetId` string
    - `profileColor` string, required
    - `createdAt` string, required
    - `updatedAt` string, required
  - `users` string[], required
  - `games` string[], required

---

[API](https://skmtc.net/versusgame/apis/versusgame-api.md) · [All operations](https://skmtc.net/versusgame/apis/versusgame-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/versusgame/versusgame-api/revisions/e86f45ae5f7c/schema)