> ## Documentation Index
> Fetch the complete documentation index at: https://ajuda.memberkit.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Lista as notificações do membro

> Retorna as notificações do membro e o total de não lidas.

As mensagens já vêm prontas para exibir, no idioma da área de membros.

`counts.unread` traz o total de notificações não lidas, de todas as páginas, para o indicador no topo do site. Peça a primeira página com `limit` igual a 1 quando só precisar do número.


## OpenAPI

````yaml headless/openapi.yml GET /api/headless/v1/notifications
openapi: 3.1.0
info:
  title: MemberKit Headless
  version: 1.0.0
servers: []
security:
  - bearer: []
    headlessKey: []
tags:
  - name: academy
  - name: auth
  - name: onboarding
  - name: courses
  - name: categories
  - name: banners
  - name: bookmarks
  - name: kv
  - name: comments
  - name: quizzes
  - name: search
  - name: ranking
  - name: profile
  - name: certificates
  - name: contact_messages
  - name: notifications
  - name: uploads
  - name: assistant
  - name: community
  - name: lessons
paths:
  /api/headless/v1/notifications:
    get:
      tags:
        - notifications
      summary: Lista as notificações do membro
      description: Retorna as notificações do membro e o total de não lidas.
      operationId: listNotifications
      parameters:
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/Page'
      responses:
        '200':
          description: Notificações
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/List'
                  - type: object
                    required:
                      - data
                      - counts
                    properties:
                      data:
                        type: array
                        items:
                          $ref: '#/components/schemas/Notification'
                      counts:
                        type: object
                        description: >-
                          Totais de todas as páginas, para o indicador de
                          notificações.
                        required:
                          - unread
                        properties:
                          unread:
                            type: integer
                            description: Notificações ainda não lidas.
        '400':
          $ref: '#/components/responses/MalformedRequest'
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '402':
          $ref: '#/components/responses/SubscriptionSuspended'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  parameters:
    Limit:
      name: limit
      in: query
      required: false
      description: Quantidade de itens por página, de 1 a 100.
      schema:
        type: integer
        default: 20
    Page:
      name: page
      in: query
      required: false
      description: Número da página, a partir de 1.
      schema:
        type: integer
        default: 1
  schemas:
    List:
      type: object
      description: Formato de todas as listas, com os itens em data.
      required:
        - page
        - total_pages
      properties:
        page:
          type: integer
          description: Página atual.
        total_pages:
          type: integer
          description: Total de páginas; 1 numa lista vazia.
    Notification:
      type: object
      required:
        - id
        - type
        - message
        - read
        - created_at
        - actor
        - target
      properties:
        id:
          type: integer
        type:
          type: string
          enum:
            - comment.replied
            - forum_comment.posted
            - forum_comment.replied
            - course.completed
            - course.unlocked
            - membership_level.unlocked
            - score.scored
          description: O que aconteceu.
        message:
          type: string
        read:
          type: boolean
        created_at:
          type: string
          format: date-time
        actor:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/Author'
        target:
          type:
            - object
            - 'null'
          description: Para onde levar o membro ao clicar.
          required:
            - type
            - id
          properties:
            type:
              type: string
              enum:
                - lesson
                - course
                - forum_post
            id:
              type: integer
    Author:
      type: object
      description: Membro como os outros membros o veem.
      required:
        - id
        - full_name
        - avatar_url
      properties:
        id:
          type: integer
        full_name:
          type: string
        avatar_url:
          $ref: '#/components/schemas/Avatar'
    Error:
      type: object
      description: Formato de todos os erros.
      required:
        - code
        - message
        - request_id
      properties:
        code:
          type: string
          description: Código do erro.
          enum:
            - subscription_suspended
            - onboarding_required
            - course_onboarding_required
            - access_expired
            - content_locked
            - comments_disabled
            - unprocessable_certificate
            - unauthenticated
            - invalid_credentials
            - invalid_token
            - invalid_headless_key
            - session_replaced
            - session_revoked
            - account_locked
            - forbidden
            - not_found
            - missing_parameter
            - malformed_request
            - validation_failed
            - invalid_signed_id
            - rate_limited
            - idempotency_key_reused
            - request_in_progress
            - assistant_unavailable
            - quiz_required
        message:
          type: string
        request_id:
          type: string
        errors:
          type: object
          description: Erros de cada campo, presentes com o código validation_failed.
          additionalProperties:
            type: array
            items:
              type: object
              required:
                - code
                - message
              properties:
                code:
                  type: string
                  description: Motivo do erro, como blank, taken, too_short ou invalid.
                message:
                  type: string
                  description: Mensagem pronta para exibir, no idioma da área de membros.
    Avatar:
      type:
        - string
        - 'null'
  responses:
    MalformedRequest:
      description: Requisição malformada (code malformed_request).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthenticated:
      description: >-
        Membro não autenticado (code unauthenticated, invalid_token,
        session_replaced, session_revoked ou invalid_headless_key).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    SubscriptionSuspended:
      description: Assinatura da área de membros suspensa (code subscription_suspended).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimited:
      description: Limite de requisições atingido (code rate_limited).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
    headlessKey:
      type: apiKey
      in: header
      name: X-Memberkit-Headless-Key
      description: >-
        Chave headless da área de membros, em Configurações. É pública e vai em
        todas as requisições, inclusive nas que levam o token do membro.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.