get_attributes

Get all attributes on an instance

Description

Retrieves all attributes from an instance as a dictionary. Complex types are automatically serialized into their JSON-compatible format.

Endpoint

get_attributes

Parameters

path · string · required

The path to the instance (e.g., “Workspace.Part” or “ReplicatedStorage.Config”)

Response

attributes · object

A dictionary of all attributes on the instance, with attribute names as keys and values serialized appropriately

error · string

Error message if the instance path could not be resolved

Examples

Get all attributes from an instance

{
  "path": "Workspace.Configuration"
}

Response:

{
  "attributes": {
    "MaxPlayers": 10,
    "GameMode": "Deathmatch",
    "AllowPvP": true,
    "SpawnPosition": {
      "type": "Vector3",
      "value": [0, 5, 0]
    },
    "TeamColor": {
      "type": "Color3",
      "value": [0, 0.5, 1]
    }
  }
}

Instance with no attributes

{
  "path": "Workspace.EmptyPart"
}

Response:

{
  "attributes": {}
}

Error handling

{
  "path": "Workspace.NonExistent"
}

Response:

{
  "error": "Instance not found: Workspace.NonExistent"
}