Data API

Authenticate, read, create, and script against FileMaker from any external system.

1

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.

2

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.

3

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.

4

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.

5

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.

6

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.

7

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.

8

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).

9

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.

10

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.

11

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.

12

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.

13

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.