Stack Exchange · Schema

Notification

An in-product notification for the authenticated user.

Q And ADeveloper CommunityKnowledge GraphStack OverflowStack ExchangeReputationTagsCommunityMCPAI Grounding

Properties

Name Type Description
notification_type string
creation_date integer
is_unread boolean
body string
post_id integer
site object A Stack Exchange community site.
View JSON Schema on GitHub

JSON Schema

stackexchange-api-v2-3-notification-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Notification",
  "description": "An in-product notification for the authenticated user.",
  "$id": "https://raw.githubusercontent.com/api-evangelist/stackexchange/refs/heads/main/json-schema/stackexchange-api-v2-3-notification-schema.json",
  "type": "object",
  "properties": {
    "notification_type": {
      "type": "string",
      "example": "badge_earned"
    },
    "creation_date": {
      "type": "integer",
      "format": "int64",
      "example": 1735000000
    },
    "is_unread": {
      "type": "boolean",
      "example": true
    },
    "body": {
      "type": "string",
      "example": "You earned the 'Nice Question' badge."
    },
    "post_id": {
      "type": "integer"
    },
    "site": {
      "type": "object",
      "description": "A Stack Exchange community site.",
      "properties": {
        "site_url": {
          "type": "string",
          "format": "uri",
          "example": "https://stackoverflow.com"
        },
        "api_site_parameter": {
          "type": "string",
          "example": "stackoverflow"
        },
        "name": {
          "type": "string",
          "example": "Stack Overflow"
        },
        "site_type": {
          "type": "string",
          "enum": [
            "main_site",
            "meta_site"
          ],
          "example": "main_site"
        },
        "audience": {
          "type": "string",
          "example": "professional and enthusiast programmers"
        },
        "icon_url": {
          "type": "string",
          "format": "uri"
        },
        "logo_url": {
          "type": "string",
          "format": "uri"
        },
        "favicon_url": {
          "type": "string",
          "format": "uri"
        },
        "launch_date": {
          "type": "integer",
          "format": "int64",
          "example": 1221177600
        },
        "site_state": {
          "type": "string",
          "enum": [
            "normal",
            "closed_beta",
            "open_beta",
            "linked_meta"
          ],
          "example": "normal"
        },
        "styling": {
          "type": "object",
          "properties": {
            "link_color": {
              "type": "string"
            },
            "tag_foreground_color": {
              "type": "string"
            },
            "tag_background_color": {
              "type": "string"
            }
          }
        },
        "related_sites": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string"
              },
              "site_url": {
                "type": "string",
                "format": "uri"
              },
              "relation": {
                "type": "string",
                "enum": [
                  "parent",
                  "meta",
                  "chat"
                ]
              }
            }
          }
        },
        "markdown_extensions": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    }
  }
}