# Claris FileMaker

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

App · 15 actions. Web page: https://docs.lodol.com/docs/integrations/claris-filemaker

## Actions

### 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 (`layout`, text, required): 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_data`, object): A value for each field to fill in. Fields left blank get their defaults (auto-enter values).
- Portal rows (`portal_data`, object): 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 (`script`, text): A script to run once the request is done, such as one that sends a notification.
- Its script parameter (`script_param`, text): Text the script after reads with Get ( ScriptParameter ).
- Script to run before (`prerequest_script`, text): A script to run before the request, such as one that sets globals.
- Its script parameter (before) (`prerequest_script_param`, text): Text the script before reads with Get ( ScriptParameter ).

**Outputs**

- `mod_id` (text): Its modification ID now
- `record_id` (text): The record's ID
- `script_results` (object): What each script run with the request returned; empty when none ran

**Example output**

```json
{
  "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 (`layout`, text, required): 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_id`, text, required): The record's ID (a number such as 147), from the trigger or another FileMaker step's record_id.
- Script to run after (`script`, text): A script to run once the request is done, such as one that sends a notification.
- Its script parameter (`script_param`, text): Text the script after reads with Get ( ScriptParameter ).
- Script to run before (`prerequest_script`, text): A script to run before the request, such as one that sets globals.
- Its script parameter (before) (`prerequest_script_param`, text): Text the script before reads with Get ( ScriptParameter ).

**Outputs**

- `deleted` (true/false): True once deleted
- `record_id` (text): The record deleted
- `script_results` (object): What each script run with the request returned; empty when none ran

**Example output**

```json
{
  "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 (`layout`, text, required): 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_id`, text, required): The record's ID (a number such as 147), from the trigger or another FileMaker step's record_id.
- Script to run after (`script`, text): A script to run once the request is done, such as one that sends a notification.
- Its script parameter (`script_param`, text): Text the script after reads with Get ( ScriptParameter ).
- Script to run before (`prerequest_script`, text): A script to run before the request, such as one that sets globals.
- Its script parameter (before) (`prerequest_script_param`, text): Text the script before reads with Get ( ScriptParameter ).

**Outputs**

- `mod_id` (text): The copy's modification ID
- `original_record_id` (text): The record that was copied
- `record_id` (text): The copy's record ID
- `script_results` (object): What each script run with the request returned; empty when none ran

**Example output**

```json
{
  "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 (`layout`, text, required): 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_id`, text, required): The record's ID (a number such as 147), from the trigger or another FileMaker step's record_id.
- Fields (`field_data`, object): The fields to change, with their new values.
- Only if modification ID is (`mod_id`, text): 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_data`, object): 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 (`script`, text): A script to run once the request is done, such as one that sends a notification.
- Its script parameter (`script_param`, text): Text the script after reads with Get ( ScriptParameter ).
- Script to run before (`prerequest_script`, text): A script to run before the request, such as one that sets globals.
- Its script parameter (before) (`prerequest_script_param`, text): Text the script before reads with Get ( ScriptParameter ).

**Outputs**

- `mod_id` (text): Its modification ID now
- `record_id` (text): The record's ID
- `script_results` (object): What each script run with the request returned; empty when none ran

**Example output**

```json
{
  "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 (`layout`, text, required): 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 (`criteria`, object): 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_requests`, list): 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_field`, text): The field to sort the records on. Leave empty to keep FileMaker's order.
- Sort order (`sort_order`, text): Ascending or descending. Defaults to ascending. One of: `ascend` (Ascending (A to Z, oldest first)), `descend` (Descending (Z to A, newest first)).
- First record (`offset`, number): Which record to start at, counting from 1. Defaults to 1. At least 1.
- Most records (`limit`, number): The most records to return, up to 1000. Defaults to 100. From 1 to 1000.
- Portals (`portals`, list): 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_offset`, number): Which related record of each named portal to start at. Defaults to 1. At least 1.
- Related records per portal (`portal_limit`, number): The most related records to return from each named portal. Defaults to 50. At least 1.
- Return fields from layout (`response_layout`, text): 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 (`script`, text): A script to run once the request is done, such as one that sends a notification.
- Its script parameter (`script_param`, text): Text the script after reads with Get ( ScriptParameter ).
- Script to run before (`prerequest_script`, text): A script to run before the request, such as one that sets globals.
- Its script parameter (before) (`prerequest_script_param`, text): Text the script before reads with Get ( ScriptParameter ).
- Script to run before sorting (`presort_script`, text): A script to run after the records are found and before they're sorted.
- Its script parameter (before sorting) (`presort_script_param`, text): Text the script before sorting reads with Get ( ScriptParameter ).

**Outputs**

- `count` (number): How many records this page holds
- `found_count` (number): How many records matched in all, across every page
- `records` (list): The records, in order
- `script_results` (object): What each script run with the request returned; empty when none ran
- `total_record_count` (number): How many records the layout's table holds

**Example output**

```json
{
  "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 (`layout`, text, required): 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_id`, text): A record whose related value lists to include. Leave empty unless a value list depends on the record.

**Outputs**

- `field_names` (list): The layout's field names
- `fields` (list): The layout's fields
- `layout` (text): The layout's name
- `portals` (object): Each portal's fields, by portal name
- `table` (text): The table occurrence it shows
- `value_lists` (list): The value lists the layout's fields use

**Example output**

```json
{
  "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**

- `product` (object): The host's FileMaker Data API engine

**Example output**

```json
{
  "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 (`layout`, text, required): 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_id`, text, required): The record's ID (a number such as 147), from the trigger or another FileMaker step's record_id.
- Portals (`portals`, list): 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_offset`, number): Which related record of each named portal to start at. Defaults to 1. At least 1.
- Related records per portal (`portal_limit`, number): The most related records to return from each named portal. Defaults to 50. At least 1.
- Return fields from layout (`response_layout`, text): 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 (`script`, text): A script to run once the request is done, such as one that sends a notification.
- Its script parameter (`script_param`, text): Text the script after reads with Get ( ScriptParameter ).
- Script to run before (`prerequest_script`, text): A script to run before the request, such as one that sets globals.
- Its script parameter (before) (`prerequest_script_param`, text): Text the script before reads with Get ( ScriptParameter ).

**Outputs**

- `mod_id` (text): Its modification ID
- `record` (object): The record
- `record_id` (text): The record's ID
- `script_results` (object): What each script run with the request returned; empty when none ran

**Example output**

```json
{
  "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 (`layout`, text, required): 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 (`offset`, number): Which record to start at, counting from 1. Defaults to 1. At least 1.
- Most records (`limit`, number): The most records to return, up to 1000. Defaults to 100. From 1 to 1000.
- Sort by (`sort_field`, text): The field to sort the records on. Leave empty to keep FileMaker's order.
- Sort order (`sort_order`, text): Ascending or descending. Defaults to ascending. One of: `ascend` (Ascending (A to Z, oldest first)), `descend` (Descending (Z to A, newest first)).
- Portals (`portals`, list): 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_offset`, number): Which related record of each named portal to start at. Defaults to 1. At least 1.
- Related records per portal (`portal_limit`, number): The most related records to return from each named portal. Defaults to 50. At least 1.
- Return fields from layout (`response_layout`, text): 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 (`script`, text): A script to run once the request is done, such as one that sends a notification.
- Its script parameter (`script_param`, text): Text the script after reads with Get ( ScriptParameter ).
- Script to run before (`prerequest_script`, text): A script to run before the request, such as one that sets globals.
- Its script parameter (before) (`prerequest_script_param`, text): Text the script before reads with Get ( ScriptParameter ).
- Script to run before sorting (`presort_script`, text): A script to run after the records are found and before they're sorted.
- Its script parameter (before sorting) (`presort_script_param`, text): Text the script before sorting reads with Get ( ScriptParameter ).

**Outputs**

- `count` (number): How many records this page holds
- `found_count` (number): How many records matched in all, across every page
- `records` (list): The records, in order
- `script_results` (object): What each script run with the request returned; empty when none ran
- `total_record_count` (number): How many records the layout's table holds

**Example output**

```json
{
  "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**

- `count` (number): How many files
- `databases` (list): The hosted files, by name

**Example output**

```json
{
  "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**

- `count` (number): How many layouts
- `layouts` (list): The layouts, folders left out

**Example output**

```json
{
  "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**

- `count` (number): How many scripts
- `scripts` (list): The scripts, folders left out

**Example output**

```json
{
  "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 (`layout`, text, required): 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_name`, text, required): The script to run.
- Script parameter (`script_param`, text): Text the script reads with Get ( ScriptParameter ).

**Outputs**

- `script_error` (text): The script's last error number; 0 if none
- `script_name` (text): The script run
- `script_result` (text): What it returned with Exit Script; empty if nothing

**Example output**

```json
{
  "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_fields`, object, required): Each global field's full name, table occurrence included, with its value, such as {"Settings::gRegion": "West"}.

**Outputs**

- `global_fields` (object): The values set
- `updated` (true/false): True once set

**Example output**

```json
{
  "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 (`layout`, text, required): 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_id`, text, required): The record's ID (a number such as 147), from the trigger or another FileMaker step's record_id.
- Container field (`field_name`, text, required): The container field to put the file in.
- File (`file`, text, required): The file to upload, or its web address.
- Repetition (`repetition`, number): For a repeating field, which repetition. Defaults to 1. At least 1.

**Outputs**

- `field_name` (text): The container field
- `file_name` (text): The file's name
- `mod_id` (text): The record's modification ID now, when FileMaker says
- `record_id` (text): The record
- `repetition` (number): The repetition filled

**Example output**

```json
{
  "field_name": "Photo",
  "file_name": "badge.jpg",
  "mod_id": "2",
  "record_id": "324",
  "repetition": 1
}
```
