The FileMaker OData API is a standards-based REST interface that allows external applications to query and update data hosted by FileMaker Server or FileMaker Cloud.
OData stands for Open Data Protocol. It is an open standard used by many databases, business-intelligence tools, integration platforms, and enterprise applications.
By supporting OData, FileMaker can expose its data through an interface that conventional web and database developers already understand.
What Can FileMaker OData Do?
The FileMaker OData API can be used to:
- retrieve database and table metadata;
- query and filter records;
- select particular fields;
- sort and paginate results;
- create, edit, and delete records;
- work with related information;
- perform several operations in one batch;
- upload and retrieve container data;
- perform aggregations and grouping;
- run FileMaker scripts;
- modify parts of the database schema;
- use webhooks to report data or schema changes.
Responses can be returned in JSON, the format most commonly used by modern REST applications.
No FileMaker Layouts Required
One of OData’s most important advantages is that a third-party developer does not need to understand FileMaker layouts.
The FileMaker Data API operates through layouts, and those layouts determine the context and fields available to an API request. Layouts, portals, table occurrences, and found sets are familiar to FileMaker developers but unfamiliar to most external developers.
OData works more directly with standard database concepts:
- tables;
- fields;
- records;
- relationships;
- metadata;
- queries.
A developer integrating FileMaker with another system can therefore work with the database without first learning how FileMaker layouts are constructed.
This reduces the dependency between the FileMaker user interface and the external integration. A FileMaker developer can redesign or reorganize layouts without necessarily affecting an OData application.
An Industry Standard
The FileMaker Data API is specific to Claris FileMaker. OData is an established industry standard with documentation, libraries, and compatible tools available across many development environments.
This offers several advantages:
- third-party developers can apply existing OData knowledge;
- standard OData clients and libraries can be used;
- metadata allows tools to discover the available database structure;
- integrations depend less on proprietary FileMaker terminology;
- business-intelligence and enterprise tools may connect more naturally;
- AI agents can inspect the schema and understand the available data more easily.
OData is similar in purpose to ODBC and JDBC, but it works over HTTPS and does not require a database driver to be installed on the client.
OData vs. the FileMaker Data API
FileMaker currently offers both OData and the FileMaker Data API.
Both can retrieve and modify FileMaker data, return JSON, run through HTTPS, and respect the security configured in the FileMaker custom app. Their approach is nevertheless different.
| FileMaker Data API | FileMaker OData API |
|---|---|
| Proprietary FileMaker API | Open industry standard |
| Operates through layouts | Operates directly on tables |
| Uses FileMaker concepts such as portals and found sets | Uses standard query and database concepts |
| Familiar to FileMaker developers | Familiar to conventional web and database developers |
| Useful for deeply FileMaker-oriented integrations | Better suited to independent and discoverable integrations |
The Data API may remain convenient when an existing integration deliberately uses layouts and FileMaker context. OData is generally the stronger choice when FileMaker must communicate with external developers, enterprise software, analytical tools, or AI systems.
Claris’s Strategic Direction
Claris has announced that no significant new development is planned for the FileMaker Data API. Future development will instead focus on OData as the preferred interface for accessing FileMaker data.
This direction is already visible in recent FileMaker releases. Claris has progressively added features such as richer metadata, advanced filtering, $expand, aggregations, batch operations, schema modification, script discovery and execution, container improvements, and webhooks.
The FileMaker Data API remains supported today, but OData is the interface developers should prioritize when designing a new long-term integration.
Easier Integration with External Developers
FileMaker is frequently only one component of a larger information system.
A website may be developed by a web agency. Financial reporting may be handled in a business-intelligence platform. Another team may maintain the CRM, accounting application, data warehouse, or AI service.
OData gives these teams a standardized view of FileMaker data without requiring them to become FileMaker specialists.
This is strategically important. The FileMaker developer remains responsible for the custom app, data structure, security, and business logic, while external developers can integrate with it using familiar tools and terminology.
OData with fmcloud.fm
fmcloud.fm supports the FileMaker OData gateway and helps customers design secure, maintainable integrations around it.
Our expertise covers both sides of the connection: the internal architecture of FileMaker custom apps and the REST technologies used by external applications. We can prepare an existing FileMaker file for OData access, review its security model, assist third-party developers, and help migrate integrations currently based on the Data API.
For customers planning new integrations, we now recommend evaluating OData first. The Data API may still be appropriate in particular circumstances, but OData provides the most future-oriented and standards-based interface.
Conclusion
The FileMaker OData API is a modern, standards-based interface for querying and updating FileMaker data.
Its principal advantage is that an external developer can interact with FileMaker using ordinary database concepts without needing to understand layouts, portals, found sets, or other FileMaker-specific mechanisms.
Because OData is an open standard and is now the focus of Claris’s API development, it should generally be the preferred interface for new FileMaker integrations.
Existing integrations can continue using the FileMaker Data API, but organizations planning long-term projects should consider whether OData offers a simpler and more sustainable architecture.
