Find Records
filemaker.find_records
ActionDatabases & warehousesconnection required
Calls the FileMaker API with the connection's credentials.
Run a find request against a layout.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- Username & password
- Providers
- FileMaker
- Secret shape
- {"username": "…", "password": "…"} — a FileMaker account with the fmrest extended privilege
- Config it needs
- base_url, database, api_version
- Resolved by
- config.connection_id, else node.connection_id
Configuration
6 fields, 2 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
layout Name of the FileMaker layout to work through; it decides which fields and portals the Data API can see. | string | Yes | — | — | Contacts |
query One object per find request, mapping field names to FileMaker find criteria; add "omit": "true" to an object to make it an omit request. | array | Yes | — | ≥ 1 characters; array of object | [{"Group":"=Surgeon"}] |
sort Sort rules, each a {"fieldName", "sortOrder"} object; sortOrder is 'ascend', 'descend' or a value list name. | array | No | — | array of object | — |
offset Record number the range starts at; FileMaker counts the first record in the found set as 1. | number | No | — | ≥ 1 | — |
limit Maximum number of records to return in one call. | number | No | — | ≥ 1 | — |
layout_response Return the record data in the context of this other layout instead of the one the request ran on. | string | No | — | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"layout": "Contacts",
"query": [
{
"Group": "=Surgeon"
}
]
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
layout The layout the records were read through. | string | — |
records The records FileMaker returned. | array | — |
records[].recordId The record's internal FileMaker id. | string | — |
records[].modId The record's modification counter. | string | — |
records[].fieldData The record's field values. | object | — |
records[].portalData Related records shown by the layout's portals. | object | — |
count How many records are in this response. | number | — |
data_info FileMaker's own counts for the request (foundCount, returnedCount, totalRecordCount) when the API version reports them. | object | — |
{
"count": 0,
"data_info": {},
"layout": "",
"records": [
{
"fieldData": {},
"modId": "",
"portalData": {},
"recordId": ""
}
]
}Related FileMaker nodes
See Find Records run in a workflow.
In a technical demo we add the FileMaker connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.