Data API
Authenticate, read, create, and script against FileMaker from any external system.
Bring the messy part
Data API making a weird face at you?
Book consulting when the lesson makes sense, but your actual file has opinions. We can untangle the design, debug the snag, or map the next build.
FileMaker Data API authentication and session tokens
Learn how to authenticate against the FileMaker Data API, get a session token, and use it for subsequent requests — including when and how to log out.
Creating records with the FileMaker Data API
Learn how to create a new record in a FileMaker layout via the Data API — including how to set field values, handle the response, and get the new record ID.
Running a FileMaker script via the Data API
Trigger a FileMaker script from outside the database using the Data API. Pass parameters, receive results, and understand the constraints of server-side execution.
Compound find queries with the FileMaker Data API
Use the _query array to send multiple find criteria in a single request, combine them with AND/OR logic, and omit unwanted records using the omit flag.
Updating a record with PATCH /records/{recordId}
Send a PATCH request to update specific fields on an existing FileMaker record. Learn the role of modId in preventing conflicting writes.
Deleting a record with DELETE /records/{recordId}
Send a DELETE request to permanently remove a FileMaker record via the Data API, and explore confirmation patterns to avoid accidental deletions.
Paginating Data API results with _limit and _offset
Control how many records the Data API returns per request and navigate through large result sets using the _limit, _offset, and _totalCount response field.
Sorting Data API results with the sort parameter
Pass a sort array in your Data API request to control the order of returned records, using fieldName and sortOrder (ascend or descend).
Including portal records in Data API responses
Request related child records alongside the parent by specifying portal names in your Data API call, and learn how to paginate within a portal.
Interpreting and handling Data API error codes
Understand how the Data API reports errors through the messages array, recognize the most common error codes, and handle them gracefully in FileMaker scripts.
Uploading a file to a container field via the Data API
Use a multipart/form-data POST request to upload a file into a FileMaker container field, and understand the two-step process of creating the record first, then uploading.
Using the metadata endpoint to inspect layout fields
Call GET /layouts/{layout}/metadata to discover which fields and portals are available on a layout, including field types and whether they are editable.
Data API best practices: sessions, scripts, and rate limits
Design reliable Data API integrations by reusing tokens, handling expiry gracefully, writing clean API-facing scripts in FileMaker, and staying within server rate limits.
Pagination with _offset and _limit
Retrieve large record sets page by page using _offset and _limit query parameters to avoid timeouts and oversized responses.
Handling FileMaker Data API errors
Interpret HTTP status codes and FileMaker error codes in API responses, and build robust error handling around every request.
Sorting records in Data API responses
Apply single and multi-field sort orders to Data API requests using the sort parameter.
Portal data in Data API responses
Read and write related records through the portal data included in Data API responses, and control which portals are returned.
Executing FileMaker scripts via the Data API
Trigger server-side FileMaker scripts from the Data API, pass parameters, and read script results.
Data API token management and session reuse
Obtain, cache, and refresh Data API tokens efficiently to minimize authentication round-trips and avoid rate limits.
Find request operators and wildcards
Use FileMaker find operators — ranges, wildcards, exact match, and negation — inside Data API query objects.
Bulk creates and updates via the Data API
Use the bulk endpoint to create or edit multiple records in a single API call, reducing round-trips for batch operations.
FileMaker Cloud vs. On-Premise Data API differences
Understand the authentication and endpoint differences between FileMaker Cloud (Claris Cloud) and on-premise FileMaker Server.
Rate limiting and retry strategies
Handle HTTP 429 responses and implement exponential backoff to build resilient Data API integrations.
Reading database and layout metadata from the Data API
Use the metadata endpoints to discover databases, layouts, and field definitions programmatically without opening FileMaker Pro.
OAuth external authentication with the Data API
Configure the Data API to accept OAuth identity provider tokens so external users authenticate with their existing organizational credentials.
Container fields via the Data API
Upload files to container fields and retrieve container URLs using the FileMaker Data API.
Compound Find Requests and Omit Logic
Build multi-request finds that combine AND, OR, and omit logic to retrieve exactly the records you need via the Data API.
Manipulating Portal Data via the Data API
Create, update, and delete related records through portals using the Data API, including creating child records without first navigating to the parent.
Triggering FileMaker Scripts from the Data API
Run server-side FileMaker scripts as part of API requests using the script parameters, and handle script results in your API response.
File Upload and Download via the Data API
Upload binary files into FileMaker container fields and download container content using the Data API, including streaming large files.
Data API Versioning and Compatibility
Understand how FileMaker Data API versioning works, when to pin a version, and how to migrate clients when server versions change.
Handling Related Data in API Responses
Retrieve parent and child records efficiently using portal data, related field references, and join-style multi-request patterns.
FileMaker Data API with Node.js
Build a reusable Node.js client for the FileMaker Data API with session management, automatic token refresh, and typed responses.
Python Integration Patterns for the Data API
Connect Python scripts and applications to FileMaker using the Data API, covering requests-based clients, context managers, and pandas integration.
Postman Testing Workflows for the FileMaker Data API
Set up a professional Postman collection for the FileMaker Data API with environment variables, automatic token management, and test scripts.
API Monitoring and Health Checks for FileMaker Integrations
Build lightweight monitoring for FileMaker Data API integrations: health check endpoints, latency tracking, alert thresholds, and error rate dashboards.
Webhook Patterns with FileMaker
Design and implement webhook-based integrations where FileMaker sends or receives event notifications, including payload validation and retry logic.
API Gateway Integration with FileMaker
Place an API gateway (such as AWS API Gateway or Kong) in front of the FileMaker Data API to add rate limiting, request transformation, and centralized authentication.
Building API Middleware for FileMaker
Create a middleware layer between clients and FileMaker that handles authentication, validation, logging, and error normalization.
Caching Strategies for FileMaker API Integrations
Implement response caching, stale-while-revalidate patterns, and cache invalidation to reduce FileMaker Server load and improve client-perceived performance.
Async and Long-Running Operations via the Data API
Handle slow FileMaker scripts and bulk operations asynchronously using job queues, polling endpoints, and server-sent events.
Automated Testing for FileMaker API Integrations
Write integration tests, contract tests, and mock servers for FileMaker Data API clients using Jest and tools like MSW.
Documenting FileMaker API Integrations
Write clear, maintainable API documentation for FileMaker integrations using OpenAPI, inline code comments, and living documentation patterns.
Error Handling Patterns for FileMaker API Integrations
Build a robust error handling layer that distinguishes network failures, FM application errors, and business logic errors, with structured logging and user-friendly messages.
Rate Limiting Strategies for FileMaker API Integrations
Implement client-side rate limiting, backoff on 429 responses, and server-side throttling to keep FileMaker integrations within safe operational limits.
Security Hardening for FileMaker API Integrations
Harden FileMaker Data API integrations against common vulnerabilities: credential storage, injection via find criteria, TLS enforcement, and session security.
GraphQL-Like Patterns with the FileMaker Data API
Build field selection, nested data requests, and query batching patterns that give the Data API GraphQL-like flexibility without adding a GraphQL layer.
Event-Driven Architecture with FileMaker
Design event-driven integration patterns where FileMaker publishes change events and external systems react, using script triggers, webhooks, and an event bus.
Real-Time Sync Patterns Between FileMaker and External Systems
Design and implement bidirectional real-time synchronization between FileMaker and external databases, including conflict resolution and sync state tracking.
Building a TypeScript SDK Wrapper for the FileMaker Data API
Design and publish a reusable TypeScript SDK that abstracts FileMaker Data API complexity, with typed schemas, fluent query builders, and tree-shakeable exports.
API Versioning Migration Strategies
Plan and execute a migration from Data API v1 to v2 (or a future version) without breaking existing clients, using parallel routing, gradual rollout, and deprecation signals.
Integrating FileMaker with Zapier and Make
Connect FileMaker to no-code automation platforms via the Data API, building custom Zaps and Make scenarios that respond to FM record changes.
Optimizing FileMaker Data API Performance
Identify and resolve the most common Data API performance bottlenecks: oversized payloads, session overhead, unindexed finds, and N+1 query patterns.
Monitoring and Logging FileMaker API Integrations at Scale
Build a comprehensive observability layer for FileMaker integrations: structured logging, distributed tracing, alerting pipelines, and SLO dashboards.
API Design Patterns for FileMaker-Backed Services
Apply proven API design patterns -- resource modeling, HATEOAS links, versioned error responses, and idempotent writes -- to services built on FileMaker.
Building a Robust FileMaker Integration: Complete Design Review
Synthesize all Data API concepts into a production-ready integration architecture checklist, covering resilience, observability, security, and maintainability.