Macro
GET /macros
Get all macros
Retrieves a list of all macros available in the Foundry world.
Parameters
| Name | Type | Required | Source | Description |
|---|---|---|---|---|
| clientId | string | query | Client ID for the Foundry world | |
| userId | string | query, body | Foundry user ID or username to scope permissions (omit for GM-level access) |
Returns
array - An array of macros with details
Try It Out
POST /macro/:uuid/execute
Execute a macro by UUID
Executes a specific macro in the Foundry world by its UUID.
Parameters
| Name | Type | Required | Source | Description |
|---|---|---|---|---|
| uuid | string | ✓ | params | UUID of the macro to execute |
| clientId | string | query | Client ID for the Foundry world | |
| args | object | body | Optional arguments to pass to the macro execution | |
| userId | string | query, body | Foundry user ID or username to scope permissions (omit for GM-level access) |
Returns
object - Result of the macro execution