{
  "opencollection": "1.0.0",
  "info": {
    "name": "Vanilla Addons Notifications API",
    "version": "2.0"
  },
  "items": [
    {
      "info": {
        "name": "Notifications",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List notifications for the current user.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://open.vanillaforums.com/api/v2/notifications",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Desired number of items per page.\n"
              },
              {
                "name": "shouldBatch",
                "value": "",
                "type": "query",
                "description": "Whether to batch notifications.\n"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number. See [Pagination](https://docs.vanillaforums.com/apiv2/#pagination).\n"
              },
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "Expand the discussion fragment in the notification.\n"
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Only return fields with these keys from the output. Use dot notation for nested fields."
              }
            ]
          },
          "docs": "List notifications for the current user."
        },
        {
          "info": {
            "name": "Mark all notifications read.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://open.vanillaforums.com/api/v2/notifications",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Mark all notifications read."
        },
        {
          "info": {
            "name": "Get a single notification.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://open.vanillaforums.com/api/v2/notifications/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The notification ID.\n"
              },
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "Expand the discussion fragment in the notification.\n"
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Only return fields with these keys from the output. Use dot notation for nested fields."
              }
            ]
          },
          "docs": "Get a single notification."
        },
        {
          "info": {
            "name": "Mark a notification read.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://open.vanillaforums.com/api/v2/notifications/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Mark a notification read."
        },
        {
          "info": {
            "name": "Mark a notification read.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://open.vanillaforums.com/api/v2/notifications/:id/read",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Mark a notification read."
        }
      ]
    }
  ],
  "bundled": true
}