Skip to main content

Description

Retrieves the same property value from multiple Roblox instances simultaneously. This is useful for inspecting or comparing property values across many objects.

HTTP Endpoint

POST /tools/mass_get_property

Parameters

paths
array
required
An array of paths to instances (e.g., [“game.Workspace.Part1”, “game.Workspace.Part2”])
property
string
required
The name of the property to retrieve from all instances

Response

results
array
An array of result objects, one for each path provided

Code Examples

Get positions from multiple parts

{
  "paths": [
    "game.Workspace.Part1",
    "game.Workspace.Part2",
    "game.Workspace.Part3"
  ],
  "property": "Position"
}

Get transparency values

{
  "paths": [
    "game.Workspace.Window1",
    "game.Workspace.Window2"
  ],
  "property": "Transparency"
}

Get names from multiple instances

{
  "paths": [
    "game.Workspace.Model.Part1",
    "game.Workspace.Model.Part2",
    "game.Workspace.Model.Part3"
  ],
  "property": "Name"
}

Example Response

Success

{
  "results": [
    {
      "path": "game.Workspace.Part1",
      "value": { "x": 10, "y": 5, "z": 0 }
    },
    {
      "path": "game.Workspace.Part2",
      "value": { "x": 20, "y": 5, "z": 10 }
    },
    {
      "path": "game.Workspace.Part3",
      "value": { "x": 30, "y": 5, "z": 20 }
    }
  ]
}

With errors

{
  "results": [
    {
      "path": "game.Workspace.Part1",
      "value": 0.5
    },
    {
      "path": "game.Workspace.InvalidPart",
      "error": "Path not found: game.Workspace.InvalidPart"
    },
    {
      "path": "game.Workspace.Part3",
      "value": 0.75
    }
  ]
}

Build docs developers (and LLMs) love