How do I use the FileMaker Data API?

The FileMaker Data API is a modern REST API built into FileMaker Server. It is the recommended integration method for connecting FileMaker to web applications, automation platforms, and external services — it is more stable and better documented than the older XML and PHP publishing approaches.

The Data API is enabled by default on all dedicated hosting plans.

Base URL

https://your-hostname.fmphost.com/fmi/data/v1/databases/YourDatabase

Quick start

  1. Authenticate: POST /sessions with your FileMaker credentials in the request body — you will receive a session token
  2. Query records: GET /layouts/YourLayout/records using the token in the Authorization header
  3. Create, update, delete: Use standard POST, PATCH, and DELETE requests on the records endpoint
  4. Log out: DELETE /sessions/{token} when you are done to release the connection

Enable Data API access in your database

  1. Open your database in FileMaker Pro
  2. Go to File > Manage > Security
  3. Edit the relevant privilege set
  4. Under Extended Privileges, enable Access via FileMaker Data API (fmrest)

What the API supports

The Data API supports filtering, sorting, pagination, portal data, container field uploads, and field-level updates. The full reference documentation is available from Claris at their developer portal.

If you are building an integration and have questions about a specific use case, open a support ticket and describe what you are building — we are glad to help point you in the right direction.

  • 0 Users Found This Useful
Was this answer helpful?

Related Articles

How do I enable ODBC/JDBC access to my FileMaker database?

ODBC and JDBC access (called "XDBC" in FileMaker Server) lets external tools — Excel, business...

How do I set up Custom Web Publishing (XML or PHP)?

Custom Web Publishing (CWP) lets you build web applications that read and write FileMaker data...