3 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 /v2/passwords/reset — openapi

Gets metadata needed for the password reset view.

Endpoint

Method: GET

Path: /v2/passwords/reset

Servers:

• https://auth.roblox.com

Parameters

[
  {
    "in": "query",
    "name": "TargetType",
    "required": true,
    "schema": {
      "type": "integer",
      "format": "int32",
      "enum": [
        0,
        1,
        2
      ]
    }
  },
  {
    "in": "query",
    "name": "Ticket",
    "required": true,
    "schema": {
      "type": "string"
    }
  }
]

Responses

{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Authentication.Api.Models.PasswordResetMetadataResponse"
        }
      },
      "text/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Authentication.Api.Models.PasswordResetMetadataResponse"
        }
      }
    }
  },
  "400": {
    "description": "3: Request was empty.\r\n9: The target type is invalid.\r\n11: The password reset ticket is invalid.\r\n14: The nonce is invalid."
  },
  "403": {
    "description": "11: The password reset ticket is invalid.\r\n16: The ticket is expired."
  },
  "500": {
    "description": "0: Unknown error occured."
  },
  "503": {
    "description": "1: Feature temporarily disabled. Please try again later."
  }
}

Authentication

{
  "security": [
    {}
  ],
  "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": {}
        }
      }
    }
  }
}

Related Schemas

• Roblox.Authentication.Api.Models.PasswordResetMetadataResponse

Complete Operation Definition

{
  "tags": [
    "Accounts",
    "Metadata"
  ],
  "summary": "Gets metadata needed for the password reset view.",
  "parameters": [
    {
      "in": "query",
      "name": "TargetType",
      "required": true,
      "schema": {
        "type": "integer",
        "format": "int32",
        "enum": [
          0,
          1,
          2
        ]
      }
    },
    {
      "in": "query",
      "name": "Ticket",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.Authentication.Api.Models.PasswordResetMetadataResponse"
          }
        },
        "text/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.Authentication.Api.Models.PasswordResetMetadataResponse"
          }
        }
      }
    },
    "400": {
      "description": "3: Request was empty.\r\n9: The target type is invalid.\r\n11: The password reset ticket is invalid.\r\n14: The nonce is invalid."
    },
    "403": {
      "description": "11: The password reset ticket is invalid.\r\n16: The ticket is expired."
    },
    "500": {
      "description": "0: Unknown error occured."
    },
    "503": {
      "description": "1: Feature temporarily disabled. Please try again later."
    }
  },
  "servers": [
    {
      "url": "https://auth.roblox.com"
    }
  ],
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "security": [
    {}
  ],
  "externalDocs": {
    "url": "https://create.roblox.com/docs/cloud/reference/features/accounts#auth_get_v2_passwords_reset"
  }
}