The Claris FileMaker Data API is a REST API that allows websites, applications, and external services to access data stored in FileMaker databases.
It provides a modern alternative to traditional Custom Web Publishing. An application sends HTTPS requests to FileMaker Server or FileMaker Cloud and receives responses in JSON, a standard format supported by virtually every modern development language.
What Can the FileMaker Data API Do?
After authentication, an external application can use the Data API to:
- find and retrieve FileMaker records;
- create, edit, and delete records;
- work with related records and portals;
- upload or download container data;
- set global fields;
- retrieve layout metadata;
- run FileMaker scripts.
This makes it possible to use FileMaker as the database and business-logic platform behind a website, mobile application, customer portal, or integration with another service.
A FileMaker-Oriented API
The Data API follows REST principles, but its structure remains closely connected to FileMaker concepts.
Requests generally operate through a layout. That layout establishes the table occurrence, context, accessible fields, portals, and related data used by the request.
This can be an advantage for FileMaker developers because the API follows concepts they already know. Dedicated integration layouts can also provide precise control over which fields and related records are available to an external application.
However, a third-party developer must understand parts of the FileMaker architecture. Terms such as layouts, portals, table occurrences, scripts, and found sets are not standard database concepts and may require explanation.
Data API or OData?
Claris currently provides two REST-based interfaces for accessing hosted FileMaker data: the FileMaker Data API and the FileMaker OData API.
The Data API is proprietary to FileMaker and closely reflects the way a FileMaker custom app works. OData is an industry-standard protocol that exposes the database structure more directly.
The distinction is especially important for external developers:
- the Data API requires knowledge of FileMaker layouts and related concepts;
- OData works directly with tables, fields, records, and standardized query options;
- the Data API is familiar to FileMaker developers;
- OData is more immediately recognizable to developers who have never used FileMaker.
The Future of the FileMaker Data API
Claris has announced that no significant new development is planned for the FileMaker Data API and that OData is now its preferred interface for future integrations.
This does not mean that the Data API has already been removed or that existing integrations will suddenly stop working. It remains available in current versions of FileMaker Server and FileMaker Cloud, and Claris continues to provide documentation and maintenance.
The strategic direction is nevertheless clear. Recent FileMaker releases have added substantial capabilities to OData, including expanded queries, aggregation, schema operations, metadata improvements, script execution, webhooks, and better container support.
For a new integration, OData should therefore normally be evaluated first.
Should Existing Data API Projects Be Rewritten?
Not automatically.
A stable Data API integration that already meets its requirements may continue to operate for years. An immediate rewrite may provide little business value.
Migration becomes more relevant when:
- the integration already requires major redevelopment;
- third-party developers find the FileMaker-specific model restrictive;
- direct table access would simplify the architecture;
- standard OData tools or libraries need to be used;
- new features are available only through OData;
- the project is expected to remain in production for many years.
The decision should be based on the expected lifetime and evolution of the integration rather than on the announcement alone.
Data API Hosting with fmcloud.fm
fmcloud.fm Starter and Pro hosting plans provide access to the FileMaker Data API gateway. Our team has extensive experience developing, hosting, diagnosing, and migrating FileMaker web integrations.
We can help determine whether an existing Data API project should remain unchanged, be progressively improved, or migrate to OData. Because we understand both the FileMaker architecture and conventional web development, we can also provide the necessary bridge between FileMaker developers and third-party development teams.
Conclusion
The FileMaker Data API is a REST interface for accessing records, layouts, portals, containers, and scripts in hosted FileMaker custom apps.
It remains a supported and widely used technology, particularly for integrations developed by teams already familiar with FileMaker. However, it depends on FileMaker-specific concepts, and Claris has announced that future API development will focus on OData.
Existing Data API applications do not necessarily require immediate migration. For new projects, however, the FileMaker OData API should now be considered the preferred starting point.
