PlanRadar Notifications API

openapi: 3.2.0
info:
  title: PlanRadar's API Documentation Approval Requests V2 Notifications API
  version: '2.0'
  description: "Welcome to PlanRadar's API documentation, here you can find all the details about our APIs as well as test them online.<br />\n        <h5>Rate Limits</h5>30 requests per minute per account, aggregated across all tokens.<br />\n        If the threshold is exceeded, a 5-minute cooldown is applied to the account, aggregated across all tokens.<br />\n        During the cooldown period, further requests may be rejected until the cooldown ends.<br />\n        In rare cases, an endpoint may have a different rate limit than the default. When that happens, the differing limit will be explicitly stated in the API documentation for that endpoint.<br />\n        <h5>Access Key</h5>In order to be able to access any API you have to create an access token.Therefore you have to follow these steps:-\n        <ul>\n          <li>Go to your profile page and click on Personal Access Tokens on the left side bar</li><li>Click on the 'Create Access Token' top right button in order to create a new access token.</li><li>Copy the created token and paste it into the field that pops up when you click on the 'Authorize' button </li><li>Note: you can copy the token only once.</li><li>Now you can easily access any API</li>\n        </ul>\n        <h5>V2 APIs</h5>We are currently working on upgrading all our APIs to v2, and we recommend that you use v2 APIs if it is available.\n        <p>V2 APIs are faster, robust and more flexible than v1 APIs</p>"
servers:
- url: /
tags:
- name: Notifications
  description: Manage all your account related notifications
paths:
  /api/v2/{customer_id}/notifications/{type}:
    get:
      summary: Get all new notification
      tags:
      - Notifications
      security:
      - apiKey: []
      parameters:
      - name: customer_id
        in: path
        required: true
        schema:
          type: string
      - name: type
        in: path
        description: 'Only allowed type: (system, tickets, downloads)'
        required: true
        schema:
          type: string
      - name: page
        in: query
        schema:
          type: integer
      - name: pagesize
        in: query
        description: Maximum is 500, default is 25
        schema:
          type: integer
      responses:
        '406':
          description: Unsupported Accept Header
  /api/v2/{customer_id}/notifications/{type}/mark_as_read:
    post:
      summary: Mark all notifications as read
      tags:
      - Notifications
      security:
      - apiKey: []
      parameters:
      - name: customer_id
        in: path
        required: true
        schema:
          type: string
      - name: type
        in: path
        description: 'Only allowed type: (system, tickets, downloads)'
        required: true
        schema:
          type: string
      responses:
        '406':
          description: Unsupported Accept Header
  /api/v2/{customer_id}/notifications/check_new:
    get:
      summary: get the count of all unread notifications for each type
      tags:
      - Notifications
      security:
      - apiKey: []
      parameters:
      - name: customer_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '406':
          description: Unsupported Accept Header
  /api/v2/{customer_id}/notifications/{notification_id}/toggle_read:
    post:
      summary: Toggle the is_read flag of one notification
      tags:
      - Notifications
      security:
      - apiKey: []
      parameters:
      - name: customer_id
        in: path
        required: true
        schema:
          type: string
      - name: notification_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '406':
          description: Unsupported Accept Header
components:
  securitySchemes:
    apiKey:
      type: apiKey
      name: X-PlanRadar-API-Key
      in: header
externalDocs:
  description: Find out more about our development portal
  url: https://www.planradar.com/knowledge-base-overview/