Data API Versioning and Compatibility

Beginner

Understand how FileMaker Data API versioning works, when to pin a version, and how to migrate clients when server versions change.

What you'll learn

  • The difference between v1, v2, and vLatest
  • Which version to use in production integrations
  • How to detect the server's supported versions
  • Best practices for version migration

The FileMaker Data API URL contains a version segment -- v1, v2, or vLatest. FileMaker Server maintains backward-compatible endpoints within a major version, but "vLatest" always resolves to the current version and can break clients silently when the server upgrades. Knowing when to pin and when to track latest keeps integrations stable.

1/4
1

Version segments in the URL

v1 is the original API, available since FileMaker 17. v2 introduced minor enhancements. vLatest always resolves to whatever version the server currently supports. For production systems, always pin to v1 or v2.

HTTP
// Pinned version -- stable, predictable
GET /fmi/data/v1/databases/MyDB/layouts/Contacts/records

// Latest -- convenient for exploration, risky in production
GET /fmi/data/vLatest/databases/MyDB/layouts/Contacts/records
File Upload and Download via the Data APIHandling Related Data in API Responses

Sign in to track your progress and pick up where you left off.

Sign in to FM Dojo