openapi: 3.0.1
info:
  title: Nakama Account Notifications API
  description: 'Representative OpenAPI description of the core REST API for Nakama, the open-source game and app backend server by Heroic Labs. Nakama''s public HTTP API is generated by the gRPC-gateway from `api/api.proto` and is published upstream as `apigrpc/apigrpc.swagger.json` in the heroiclabs/nakama repository. This document reconstructs the primary client-facing surface: authentication, accounts and identity linking, social (friends and groups), storage, leaderboards and tournaments, notifications, and custom RPCs.


    Authentication endpoints are guarded by the server key using HTTP Basic auth, where the server key is the username and the password is empty. All other endpoints are authorized with the JWT session token returned by an authenticate call, sent as `Authorization: Bearer <session_token>`. RPC endpoints may alternatively be called server-to-server with an `http_key` query parameter.'
  termsOfService: https://heroiclabs.com/terms/
  contact:
    name: Heroic Labs
    url: https://heroiclabs.com/
    email: support@heroiclabs.com
  license:
    name: Apache 2.0
    url: https://github.com/heroiclabs/nakama/blob/master/LICENSE
  version: '2.0'
servers:
- url: http://127.0.0.1:7350
  description: Default self-hosted Nakama server. Replace host/port with your Heroic Cloud project URL in production.
security:
- BearerAuth: []
tags:
- name: Notifications
  description: List and delete in-app notifications.
paths:
  /v2/notification:
    get:
      operationId: listNotifications
      tags:
      - Notifications
      summary: Fetch a list of notifications.
      parameters:
      - in: query
        name: limit
        schema:
          type: integer
          format: int32
        description: The number of notifications to get. Between 1 and 100.
      - in: query
        name: cacheable_cursor
        schema:
          type: string
        description: A cursor to page through notifications, usually cached client-side.
      responses:
        '200':
          description: A collection of notifications.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationList'
    delete:
      operationId: deleteNotifications
      tags:
      - Notifications
      summary: Delete one or more notifications for the current user.
      parameters:
      - in: query
        name: ids
        schema:
          type: array
          items:
            type: string
        description: The id of notifications to delete.
      responses:
        '200':
          description: The notifications were deleted.
components:
  schemas:
    Notification:
      type: object
      description: A notification in the server.
      properties:
        id:
          type: string
        subject:
          type: string
        content:
          type: string
          description: Content payload, a JSON-encoded string.
        code:
          type: integer
          format: int32
          description: Category code for this notification.
        sender_id:
          type: string
        create_time:
          type: string
          format: date-time
        persistent:
          type: boolean
    NotificationList:
      type: object
      properties:
        notifications:
          type: array
          items:
            $ref: '#/components/schemas/Notification'
        cacheable_cursor:
          type: string
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
      description: HTTP Basic auth using the server key as the username and an empty password. Guards the authenticate endpoints.
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'The JWT session token returned by an authenticate call, sent as `Authorization: Bearer <session_token>`.'
externalDocs:
  description: Nakama documentation
  url: https://heroiclabs.com/docs/nakama/