The FileMaker Custom App API

Intermediate

Understand the Custom App API -- what it is, how it relates to OData, and when to use it.

What you'll learn

The three components of the FileMaker Custom App API
Data API vs. OData vs. Admin API -- when to use each
Authentication differences between the three APIs
Versioning and compatibility between API versions

The FileMaker Custom App API is a broader term for the collection of REST-based access methods FileMaker Server provides: the Data API, the OData endpoint, and the Admin API. Understanding how these three APIs relate -- their purposes, authentication models, and capabilities -- helps you choose the right tool for each integration scenario.

1/4

The three API components

**FileMaker Data API**: FileMaker-native REST API. Supports layouts, portals, scripts, find requests, and FileMaker-specific operations. Token-based authentication. URL: `/fmi/data/v1/` **OData endpoint**: Standards-based REST API. Supports any OData-compatible tool. Basic auth. URL: `/fmi/odata/v4/` **Admin API**: Server management REST API. Manage files, schedules, clients, and server configuration. Token-based auth. URL: `/fmadmin/api/v2/`

TEXT

// API URL patterns:
// Data API: /fmi/data/v1/databases/{db}/...
// OData:    /fmi/odata/v4/{db}/...
// Admin API: /fmadmin/api/v2/...

Connecting Tableau to FileMaker via OData Real-Time Data Patterns with FileMaker OData