Claris FileMaker
App · 15 actions
Work with the records in your FileMaker apps: create, find, edit, copy and delete records, upload files to container fields, run scripts and set globals, and start workflows when records are added or changed.
Actions
| Action | What it does |
|---|---|
| Create record | Add a record through a layout, with a value for each field you fill in and, optionally, related records through its portals. |
| Delete record | Delete a record for good. |
| Duplicate record | Make a copy of a record, as FileMaker's Duplicate Record does. |
| Edit record | Change some fields of a record. |
| Find records | Find records the way FileMaker's Find mode does, such as every invoice over 500 that isn't paid, with operators like >=, ..., * and ==, and omit requests. |
| Get layout metadata | Get a layout's fields with their types, its portals and their fields, and its value lists. |
| Get product info | Get the FileMaker host's product name and version, and the date, time and timestamp formats it uses. |
| Get record | Get one record by its ID, with its fields and its portals' related records. |
| Get records | Get a range of a layout's records, such as the first 100 or the 20 most recently changed, with their portals' related records. |
| List databases | List the FileMaker files the host serves that the connected account can open. |
| List layouts | List the connected file's layouts, with the folder each is in and the table it shows. |
| List scripts | List the connected file's scripts, with the folder each is in. |
| Run script | Run a FileMaker script on a layout, with a script parameter, and get what it returns with Exit Script. |
| Set global fields | Set global fields for this connection's FileMaker session, so the steps after it (and their scripts and relationships) see the values for the next 15 minutes. |
| Upload file to container field | Put a file, such as a signed PDF or a photo, into a record's container field, replacing what it held. |
Create record
Add a record through a layout, with a value for each field you fill in and, optionally, related records through its portals.
Inputs
- Layout
layouttextRequired - The layout to work through, such as Contacts. Only the fields and portals on it can be read or written. Pick it, or type its name.
- Fields
field_dataobject - A value for each field to fill in. Fields left blank get their defaults (auto-enter values).
- Portal rows
portal_dataobject - Related records to add (or change) through portals: each portal's name with a list of rows, such as {"Phones": [{"Phones::Number": "555-0100"}]}. To change a row, include its recordId.
- Script to run after
scripttext - A script to run once the request is done, such as one that sends a notification.
- Its script parameter
script_paramtext - Text the script after reads with Get ( ScriptParameter ).
- Script to run before
prerequest_scripttext - A script to run before the request, such as one that sets globals.
- Its script parameter (before)
prerequest_script_paramtext - Text the script before reads with Get ( ScriptParameter ).
Outputs
mod_idtext- Its modification ID now
record_idtext- The record's ID
script_resultsobject- What each script run with the request returned; empty when none ran
Example output
{
"mod_id": "0",
"record_id": "324",
"script_results": {
"prerequest": {
"error": "",
"result": ""
},
"presort": {
"error": "",
"result": ""
},
"script": {
"error": "",
"result": ""
}
}
}Delete record
Delete a record for good.
Inputs
- Layout
layouttextRequired - The layout to work through, such as Contacts. Only the fields and portals on it can be read or written. Pick it, or type its name.
- Record ID
record_idtextRequired - The record's ID (a number such as 147), from the trigger or another FileMaker step's record_id.
- Script to run after
scripttext - A script to run once the request is done, such as one that sends a notification.
- Its script parameter
script_paramtext - Text the script after reads with Get ( ScriptParameter ).
- Script to run before
prerequest_scripttext - A script to run before the request, such as one that sets globals.
- Its script parameter (before)
prerequest_script_paramtext - Text the script before reads with Get ( ScriptParameter ).
Outputs
deletedtrue/false- True once deleted
record_idtext- The record deleted
script_resultsobject- What each script run with the request returned; empty when none ran
Example output
{
"deleted": true,
"record_id": "324",
"script_results": {
"prerequest": {
"error": "",
"result": ""
},
"presort": {
"error": "",
"result": ""
},
"script": {
"error": "",
"result": ""
}
}
}Duplicate record
Make a copy of a record, as FileMaker's Duplicate Record does.
Inputs
- Layout
layouttextRequired - The layout to work through, such as Contacts. Only the fields and portals on it can be read or written. Pick it, or type its name.
- Record ID
record_idtextRequired - The record's ID (a number such as 147), from the trigger or another FileMaker step's record_id.
- Script to run after
scripttext - A script to run once the request is done, such as one that sends a notification.
- Its script parameter
script_paramtext - Text the script after reads with Get ( ScriptParameter ).
- Script to run before
prerequest_scripttext - A script to run before the request, such as one that sets globals.
- Its script parameter (before)
prerequest_script_paramtext - Text the script before reads with Get ( ScriptParameter ).
Outputs
mod_idtext- The copy's modification ID
original_record_idtext- The record that was copied
record_idtext- The copy's record ID
script_resultsobject- What each script run with the request returned; empty when none ran
Example output
{
"mod_id": "0",
"original_record_id": "324",
"record_id": "325",
"script_results": {
"prerequest": {
"error": "",
"result": ""
},
"presort": {
"error": "",
"result": ""
},
"script": {
"error": "",
"result": ""
}
}
}Edit record
Change some fields of a record. Fields left blank keep their values. Give its modification ID to change it only if nobody has since.
Inputs
- Layout
layouttextRequired - The layout to work through, such as Contacts. Only the fields and portals on it can be read or written. Pick it, or type its name.
- Record ID
record_idtextRequired - The record's ID (a number such as 147), from the trigger or another FileMaker step's record_id.
- Fields
field_dataobject - The fields to change, with their new values.
- Only if modification ID is
mod_idtext - The record's mod_id from when it was read. FileMaker refuses the edit if the record has changed since. Leave empty to edit it regardless.
- Portal rows
portal_dataobject - Related records to add (or change) through portals: each portal's name with a list of rows, such as {"Phones": [{"Phones::Number": "555-0100"}]}. To change a row, include its recordId.
- Script to run after
scripttext - A script to run once the request is done, such as one that sends a notification.
- Its script parameter
script_paramtext - Text the script after reads with Get ( ScriptParameter ).
- Script to run before
prerequest_scripttext - A script to run before the request, such as one that sets globals.
- Its script parameter (before)
prerequest_script_paramtext - Text the script before reads with Get ( ScriptParameter ).
Outputs
mod_idtext- Its modification ID now
record_idtext- The record's ID
script_resultsobject- What each script run with the request returned; empty when none ran
Example output
{
"mod_id": "1",
"record_id": "324",
"script_results": {
"prerequest": {
"error": "",
"result": ""
},
"presort": {
"error": "",
"result": ""
},
"script": {
"error": "",
"result": ""
}
}
}Find records
Find records the way FileMaker's Find mode does, such as every invoice over 500 that isn't paid, with operators like >=, ..., * and ==, and omit requests. Finding nothing returns no records rather than an error.
Inputs
- Layout
layouttextRequired - The layout to work through, such as Contacts. Only the fields and portals on it can be read or written. Pick it, or type its name.
- Find
criteriaobject - What to find in each field, as you'd type it in Find mode: Smith, ==Smith for an exact match, >=500, 1/1/2026...1/31/2026, or = for empty. Fields left blank aren't searched.
- More find requests
more_requestslist - Further find requests, each an object of fields and what to find, such as [{"State": "CA"}]. Add "omit": "true" to one to leave out what it matches.
- Sort by
sort_fieldtext - The field to sort the records on. Leave empty to keep FileMaker's order.
- Sort order
sort_ordertext - Ascending or descending. Defaults to ascending.One of:
ascend(Ascending (A to Z, oldest first)),descend(Descending (Z to A, newest first)). - First record
offsetnumber - Which record to start at, counting from 1. Defaults to 1.At least 1.
- Most records
limitnumber - The most records to return, up to 1000. Defaults to 100.From 1 to 1000.
- Portals
portalslist - The portals to return related records from, by object name or related table name. Leave empty for every portal on the layout.
- First related record
portal_offsetnumber - Which related record of each named portal to start at. Defaults to 1.At least 1.
- Related records per portal
portal_limitnumber - The most related records to return from each named portal. Defaults to 50.At least 1.
- Return fields from layout
response_layouttext - Return the records' fields as another layout of the same table shows them. Leave empty to use the layout above's fields.
- Script to run after
scripttext - A script to run once the request is done, such as one that sends a notification.
- Its script parameter
script_paramtext - Text the script after reads with Get ( ScriptParameter ).
- Script to run before
prerequest_scripttext - A script to run before the request, such as one that sets globals.
- Its script parameter (before)
prerequest_script_paramtext - Text the script before reads with Get ( ScriptParameter ).
- Script to run before sorting
presort_scripttext - A script to run after the records are found and before they're sorted.
- Its script parameter (before sorting)
presort_script_paramtext - Text the script before sorting reads with Get ( ScriptParameter ).
Outputs
countnumber- How many records this page holds
found_countnumber- How many records matched in all, across every page
recordslist- The records, in order
script_resultsobject- What each script run with the request returned; empty when none ran
total_record_countnumber- How many records the layout's table holds
Example output
{
"count": 1,
"found_count": 1,
"records": [
{
"fields": {
"Created": "11/10/2026 09:30:00",
"Email": "jo@example.com",
"Name": "Jo Bloggs",
"Status": "Active"
},
"mod_id": "0",
"portals": {
"Phones": [
{
"Phones::Number": "555-0100",
"modId": "0",
"recordId": "12"
}
]
},
"record_id": "324"
}
],
"script_results": {
"prerequest": {
"error": "",
"result": ""
},
"presort": {
"error": "",
"result": ""
},
"script": {
"error": "",
"result": ""
}
},
"total_record_count": 42
}Get layout metadata
Get a layout's fields with their types, its portals and their fields, and its value lists.
Inputs
- Layout
layouttextRequired - The layout to work through, such as Contacts. Only the fields and portals on it can be read or written. Pick it, or type its name.
- Record ID
record_idtext - A record whose related value lists to include. Leave empty unless a value list depends on the record.
Outputs
field_nameslist- The layout's field names
fieldslist- The layout's fields
layouttext- The layout's name
portalsobject- Each portal's fields, by portal name
tabletext- The table occurrence it shows
value_listslist- The value lists the layout's fields use
Example output
{
"field_names": [
"Status"
],
"fields": [
{
"autoEnter": false,
"displayType": "popupList",
"fourDigitYear": false,
"global": false,
"maxCharacters": 0,
"maxRepeat": 1,
"name": "Status",
"notEmpty": false,
"numeric": false,
"repetitionEnd": 1,
"repetitionStart": 1,
"result": "text",
"timeOfDay": false,
"type": "normal",
"valueList": "Statuses"
}
],
"layout": "Contacts",
"portals": {
"Phones": [
{
"autoEnter": false,
"displayType": "popupList",
"fourDigitYear": false,
"global": false,
"maxCharacters": 0,
"maxRepeat": 1,
"name": "Phones::Number",
"notEmpty": false,
"numeric": false,
"repetitionEnd": 1,
"repetitionStart": 1,
"result": "text",
"timeOfDay": false,
"type": "normal",
"valueList": "Statuses"
}
]
},
"table": "",
"value_lists": [
{
"name": "Statuses",
"type": "customList",
"values": [
{
"displayValue": "Active",
"value": "Active"
},
{
"displayValue": "Closed",
"value": "Closed"
}
]
}
]
}Get product info
Get the FileMaker host's product name and version, and the date, time and timestamp formats it uses.
Inputs
None.
Outputs
productobject- The host's FileMaker Data API engine
Example output
{
"product": {
"buildDate": "03/18/2025",
"dateFormat": "MM/dd/yyyy",
"name": "FileMaker Data API Engine",
"timeFormat": "HH:mm:ss",
"timeStampFormat": "MM/dd/yyyy HH:mm:ss",
"version": "22.0.1.68"
}
}Get record
Get one record by its ID, with its fields and its portals' related records.
Inputs
- Layout
layouttextRequired - The layout to work through, such as Contacts. Only the fields and portals on it can be read or written. Pick it, or type its name.
- Record ID
record_idtextRequired - The record's ID (a number such as 147), from the trigger or another FileMaker step's record_id.
- Portals
portalslist - The portals to return related records from, by object name or related table name. Leave empty for every portal on the layout.
- First related record
portal_offsetnumber - Which related record of each named portal to start at. Defaults to 1.At least 1.
- Related records per portal
portal_limitnumber - The most related records to return from each named portal. Defaults to 50.At least 1.
- Return fields from layout
response_layouttext - Return the records' fields as another layout of the same table shows them. Leave empty to use the layout above's fields.
- Script to run after
scripttext - A script to run once the request is done, such as one that sends a notification.
- Its script parameter
script_paramtext - Text the script after reads with Get ( ScriptParameter ).
- Script to run before
prerequest_scripttext - A script to run before the request, such as one that sets globals.
- Its script parameter (before)
prerequest_script_paramtext - Text the script before reads with Get ( ScriptParameter ).
Outputs
mod_idtext- Its modification ID
recordobject- The record
record_idtext- The record's ID
script_resultsobject- What each script run with the request returned; empty when none ran
Example output
{
"mod_id": "0",
"record": {
"fields": {
"Created": "11/10/2026 09:30:00",
"Email": "jo@example.com",
"Name": "Jo Bloggs",
"Status": "Active"
},
"mod_id": "0",
"portals": {
"Phones": [
{
"Phones::Number": "555-0100",
"modId": "0",
"recordId": "12"
}
]
},
"record_id": "324"
},
"record_id": "324",
"script_results": {
"prerequest": {
"error": "",
"result": ""
},
"presort": {
"error": "",
"result": ""
},
"script": {
"error": "",
"result": ""
}
}
}Get records
Get a range of a layout's records, such as the first 100 or the 20 most recently changed, with their portals' related records.
Inputs
- Layout
layouttextRequired - The layout to work through, such as Contacts. Only the fields and portals on it can be read or written. Pick it, or type its name.
- First record
offsetnumber - Which record to start at, counting from 1. Defaults to 1.At least 1.
- Most records
limitnumber - The most records to return, up to 1000. Defaults to 100.From 1 to 1000.
- Sort by
sort_fieldtext - The field to sort the records on. Leave empty to keep FileMaker's order.
- Sort order
sort_ordertext - Ascending or descending. Defaults to ascending.One of:
ascend(Ascending (A to Z, oldest first)),descend(Descending (Z to A, newest first)). - Portals
portalslist - The portals to return related records from, by object name or related table name. Leave empty for every portal on the layout.
- First related record
portal_offsetnumber - Which related record of each named portal to start at. Defaults to 1.At least 1.
- Related records per portal
portal_limitnumber - The most related records to return from each named portal. Defaults to 50.At least 1.
- Return fields from layout
response_layouttext - Return the records' fields as another layout of the same table shows them. Leave empty to use the layout above's fields.
- Script to run after
scripttext - A script to run once the request is done, such as one that sends a notification.
- Its script parameter
script_paramtext - Text the script after reads with Get ( ScriptParameter ).
- Script to run before
prerequest_scripttext - A script to run before the request, such as one that sets globals.
- Its script parameter (before)
prerequest_script_paramtext - Text the script before reads with Get ( ScriptParameter ).
- Script to run before sorting
presort_scripttext - A script to run after the records are found and before they're sorted.
- Its script parameter (before sorting)
presort_script_paramtext - Text the script before sorting reads with Get ( ScriptParameter ).
Outputs
countnumber- How many records this page holds
found_countnumber- How many records matched in all, across every page
recordslist- The records, in order
script_resultsobject- What each script run with the request returned; empty when none ran
total_record_countnumber- How many records the layout's table holds
Example output
{
"count": 1,
"found_count": 1,
"records": [
{
"fields": {
"Created": "11/10/2026 09:30:00",
"Email": "jo@example.com",
"Name": "Jo Bloggs",
"Status": "Active"
},
"mod_id": "0",
"portals": {
"Phones": [
{
"Phones::Number": "555-0100",
"modId": "0",
"recordId": "12"
}
]
},
"record_id": "324"
}
],
"script_results": {
"prerequest": {
"error": "",
"result": ""
},
"presort": {
"error": "",
"result": ""
},
"script": {
"error": "",
"result": ""
}
},
"total_record_count": 42
}List databases
List the FileMaker files the host serves that the connected account can open.
Inputs
None.
Outputs
countnumber- How many files
databaseslist- The hosted files, by name
Example output
{
"count": 2,
"databases": [
{
"name": "Contacts"
},
{
"name": "Invoices"
}
]
}List layouts
List the connected file's layouts, with the folder each is in and the table it shows.
Inputs
None.
Outputs
countnumber- How many layouts
layoutslist- The layouts, folders left out
Example output
{
"count": 2,
"layouts": [
{
"folder": "",
"name": "Contacts",
"table": "Contacts"
},
{
"folder": "Package Management",
"name": "Mark as sent",
"table": "Packages"
}
]
}List scripts
List the connected file's scripts, with the folder each is in.
Inputs
None.
Outputs
countnumber- How many scripts
scriptslist- The scripts, folders left out
Example output
{
"count": 2,
"scripts": [
{
"folder": "",
"name": "Send reminder"
},
{
"folder": "Admin",
"name": "Nightly export"
}
]
}Run script
Run a FileMaker script on a layout, with a script parameter, and get what it returns with Exit Script.
Inputs
- Layout
layouttextRequired - The layout to work through, such as Contacts. Only the fields and portals on it can be read or written. Pick it, or type its name.
- Script
script_nametextRequired - The script to run.
- Script parameter
script_paramtext - Text the script reads with Get ( ScriptParameter ).
Outputs
script_errortext- The script's last error number; 0 if none
script_nametext- The script run
script_resulttext- What it returned with Exit Script; empty if nothing
Example output
{
"script_error": "0",
"script_name": "Send reminder",
"script_result": "Sent"
}Set global fields
Set global fields for this connection's FileMaker session, so the steps after it (and their scripts and relationships) see the values for the next 15 minutes.
Inputs
- Global fields
global_fieldsobjectRequired - Each global field's full name, table occurrence included, with its value, such as {"Settings::gRegion": "West"}.
Outputs
global_fieldsobject- The values set
updatedtrue/false- True once set
Example output
{
"global_fields": {
"Settings::gRegion": "West"
},
"updated": true
}Upload file to container field
Put a file, such as a signed PDF or a photo, into a record's container field, replacing what it held.
Inputs
- Layout
layouttextRequired - The layout to work through, such as Contacts. Only the fields and portals on it can be read or written. Pick it, or type its name.
- Record ID
record_idtextRequired - The record's ID (a number such as 147), from the trigger or another FileMaker step's record_id.
- Container field
field_nametextRequired - The container field to put the file in.
- File
filetextRequired - The file to upload, or its web address.
- Repetition
repetitionnumber - For a repeating field, which repetition. Defaults to 1.At least 1.
Outputs
field_nametext- The container field
file_nametext- The file's name
mod_idtext- The record's modification ID now, when FileMaker says
record_idtext- The record
repetitionnumber- The repetition filled
Example output
{
"field_name": "Photo",
"file_name": "badge.jpg",
"mod_id": "2",
"record_id": "324",
"repetition": 1
}