Away 7:52 PM

2 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

GET /v1/announcements — openapi

Migrate from RobloxWebsite project, return news notification for Private Message page

Endpoint

Method: GET

Path: /v1/announcements

Servers:

Responses

StatusDescription
200OK
4002: Message does not exist or the current user is not authorized to view it.
4010: Authorization has been denied for this request.
 
{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.PrivateMessages.Api.Models.GetAnnouncementsResponse"
        }
      },
      "text/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.PrivateMessages.Api.Models.GetAnnouncementsResponse"
        }
      }
    }
  },
  "400": {
    "description": "2: Message does not exist or the current user is not authorized to view it."
  },
  "401": {
    "description": "0: Authorization has been denied for this request."
  }
}

Authentication

{
  "security": [
    {
      "roblox-legacy-cookie": []
    }
  ],
  "securitySchemes": {
    "roblox-api-key": {
      "type": "apiKey",
      "description": "A configurable key that allows granular access to Roblox resources. See https://create.roblox.com/docs/cloud/auth/api-keys for more information.",
      "name": "x-api-key",
      "in": "header"
    },
    "roblox-legacy-cookie": {
      "type": "apiKey",
      "description": "A browser cookie that represents the identity of a Roblox user. DO NOT SHARE THIS. Sharing this will allow someone to log in as you and to steal your Robux and items. We do not recommend using cookies to call endpoints. When possible, use API keys with the x-api-key header or OAuth 2.0 instead for authentication.",
      "in": "cookie",
      "name": ".ROBLOSECURITY"
    },
    "roblox-oauth2": {
      "type": "oauth2",
      "description": "Build or authorize apps to access Roblox resources. See https://create.roblox.com/docs/cloud/auth/oauth2-overview for more information.",
      "flows": {
        "authorizationCode": {
          "authorizationUrl": "https://apis.roblox.com/oauth/v1/authorize",
          "tokenUrl": "https://apis.roblox.com/oauth/v1/token",
          "refreshUrl": "https://apis.roblox.com/oauth/v1/token",
          "scopes": {}
        }
      }
    }
  }
}

Complete Operation Definition

{
  "tags": [
    "Accounts"
  ],
  "summary": "Migrate from RobloxWebsite project, return news notification for Private Message page",
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.PrivateMessages.Api.Models.GetAnnouncementsResponse"
          }
        },
        "text/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.PrivateMessages.Api.Models.GetAnnouncementsResponse"
          }
        }
      }
    },
    "400": {
      "description": "2: Message does not exist or the current user is not authorized to view it."
    },
    "401": {
      "description": "0: Authorization has been denied for this request."
    }
  },
  "servers": [
    {
      "url": "https://privatemessages.roblox.com"
    }
  ],
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "security": [
    {
      "roblox-legacy-cookie": []
    }
  ],
  "externalDocs": {
    "url": "https://create.roblox.com/docs/cloud/reference/features/accounts#privatemessages_get_v1_announcements"
  }
}