Running a FileMaker script via the Data API

Intermediate

Trigger a FileMaker script from outside the database using the Data API. Pass parameters, receive results, and understand the constraints of server-side execution.

What you'll learn

How to call a FileMaker script from the Data API
How to pass a parameter and receive the script result
What limitations apply to scripts run via the Data API

The Data API can trigger a FileMaker script and optionally pass it a parameter. Scripts run on the server in a headless environment — no UI, no user interaction. The script result is returned in the API response.

1/3

Run a script as part of a find request

The most common pattern is to run a script alongside a find: GET /records with ?script= query parameters. The script runs after the find.

JSON

// GET /fmi/data/v1/databases/MyDB/layouts/Customers/records
//   ?script=ProcessCustomers
//   &script.param=%7B%22mode%22%3A%22export%22%7D   (URL-encoded JSON)
// Authorization: Bearer {token}

Creating records with the FileMaker Data API Compound find queries with the FileMaker Data API