{
  "opencollection": "1.0.0",
  "info": {
    "name": "Baserow API spec Admin Notifications API",
    "version": "2.2.2"
  },
  "items": [
    {
      "info": {
        "name": "Notifications",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "list_workspace_notifications",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/notifications/:workspace_id/",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Defines how many notifications should be returned."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Defines the offset of the notifications that should be returned."
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "path",
                "description": "The workspace id that the notifications belong to."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Lists the notifications for the given workspace and the current user. The response is paginated and the limit and offset parameters can be controlled using the query parameters."
        },
        {
          "info": {
            "name": "clear_workspace_notifications",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/notifications/:workspace_id/",
            "params": [
              {
                "name": "workspace_id",
                "value": "",
                "type": "path",
                "description": "The workspace the notifications are in."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Clear all the notifications for the given workspace and user."
        },
        {
          "info": {
            "name": "mark_notification_as_read",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/notifications/:workspace_id/:notification_id/",
            "params": [
              {
                "name": "notification_id",
                "value": "",
                "type": "path",
                "description": "The notification id to update."
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "path",
                "description": "The workspace the notification is in."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Marks a notification as read."
        },
        {
          "info": {
            "name": "mark_all_workspace_notifications_as_read",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/notifications/:workspace_id/mark-all-as-read/",
            "params": [
              {
                "name": "workspace_id",
                "value": "",
                "type": "path",
                "description": "The workspace the notifications are in."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Mark as read all the notifications for the given workspace and user."
        }
      ]
    }
  ],
  "bundled": true
}