4 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 /place-version-history-api/v1/{placeId}/history — openapi

Endpoint used to get place versions, using various filters

Endpoint

Method: GET

Path: /place-version-history-api/v1/{placeId}/history

Servers:

Parameters

NameLocationRequiredDescription
placeIdpathtrue
cursorqueryfalse
isPublishedqueryfalse
hasNotesqueryfalse
saveTypequeryfalse
searchTermqueryfalse
contributorqueryfalse
startTimequeryfalse
endTimequeryfalse
pageSizequeryfalse
[
  {
    "name": "placeId",
    "in": "path",
    "required": true,
    "schema": {
      "minimum": 1,
      "type": "integer",
      "format": "int64"
    }
  },
  {
    "name": "cursor",
    "in": "query",
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "isPublished",
    "in": "query",
    "schema": {
      "type": "boolean"
    }
  },
  {
    "name": "hasNotes",
    "in": "query",
    "schema": {
      "type": "boolean"
    }
  },
  {
    "name": "saveType",
    "in": "query",
    "schema": {
      "type": "integer",
      "format": "int32"
    }
  },
  {
    "name": "searchTerm",
    "in": "query",
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "contributor",
    "in": "query",
    "schema": {
      "type": "integer",
      "format": "int64"
    }
  },
  {
    "name": "startTime",
    "in": "query",
    "schema": {
      "type": "string",
      "format": "date-time"
    }
  },
  {
    "name": "endTime",
    "in": "query",
    "schema": {
      "type": "string",
      "format": "date-time"
    }
  },
  {
    "name": "pageSize",
    "in": "query",
    "schema": {
      "type": "integer",
      "format": "int32"
    }
  }
]

Responses

StatusDescription
200Success
400Bad Request
401Unauthorized
403Forbidden
500Server Error
{
  "200": {
    "description": "Success",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/GetPlaceVersionHistoryResponse"
        }
      }
    }
  },
  "400": {
    "description": "Bad Request",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OperationErrorResponse"
        }
      }
    }
  },
  "401": {
    "description": "Unauthorized",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OperationErrorResponse"
        }
      }
    }
  },
  "403": {
    "description": "Forbidden",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OperationErrorResponse"
        }
      }
    }
  },
  "500": {
    "description": "Server Error",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OperationErrorResponse"
        }
      }
    }
  }
}

Authentication

{
  "security": [
    {
      "roblox-legacy-cookie": []
    },
    {
      "roblox-api-key": []
    }
  ],
  "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": [
    "Places"
  ],
  "summary": "Endpoint used to get place versions, using various filters",
  "operationId": "PlaceVersion_GetPlaceVersionHistory",
  "parameters": [
    {
      "name": "placeId",
      "in": "path",
      "required": true,
      "schema": {
        "minimum": 1,
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "cursor",
      "in": "query",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "isPublished",
      "in": "query",
      "schema": {
        "type": "boolean"
      }
    },
    {
      "name": "hasNotes",
      "in": "query",
      "schema": {
        "type": "boolean"
      }
    },
    {
      "name": "saveType",
      "in": "query",
      "schema": {
        "type": "integer",
        "format": "int32"
      }
    },
    {
      "name": "searchTerm",
      "in": "query",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "contributor",
      "in": "query",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "startTime",
      "in": "query",
      "schema": {
        "type": "string",
        "format": "date-time"
      }
    },
    {
      "name": "endTime",
      "in": "query",
      "schema": {
        "type": "string",
        "format": "date-time"
      }
    },
    {
      "name": "pageSize",
      "in": "query",
      "schema": {
        "type": "integer",
        "format": "int32"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/GetPlaceVersionHistoryResponse"
          }
        }
      }
    },
    "400": {
      "description": "Bad Request",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/OperationErrorResponse"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/OperationErrorResponse"
          }
        }
      }
    },
    "403": {
      "description": "Forbidden",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/OperationErrorResponse"
          }
        }
      }
    },
    "500": {
      "description": "Server Error",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/OperationErrorResponse"
          }
        }
      }
    }
  },
  "x-roblox-stability": "EXPERIMENTAL",
  "x-roblox-rate-limits": {
    "perApiKeyOwner": {
      "period": "MINUTE",
      "maxInPeriod": 120
    }
  },
  "x-roblox-scopes": [
    {
      "name": "universe.place:read",
      "targetResourceSpecifier": ""
    }
  ],
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "security": [
    {
      "roblox-legacy-cookie": []
    },
    {
      "roblox-api-key": []
    }
  ],
  "externalDocs": {
    "url": "https://create.roblox.com/docs/cloud/reference/features/places#PlaceVersion_GetPlaceVersionHistory"
  }
}