Portal data in Data API responses

Expert

Read and write related records through the portal data included in Data API responses, and control which portals are returned.

What you'll learn

Where portal data appears in a Data API response
How to control which portals are included and how many rows
How to create and update related records through portals via the API

When a FileMaker layout includes portals, the Data API automatically includes related records in the response under a portalData key. You can also write to portal records (related records) through the same API, enabling full CRUD on related data without separate API calls.

1/3

Reading portal data in a response

Related records appear under response.data[n].portalData, keyed by the portal's object name (not the TO name). Each portal row has its own fieldData and recordId.

JSON

{
  "response": {
    "data": [{
      "fieldData": { "Name": "Acme Corp", "Status": "Active" },
      "portalData": {
        "portal_LineItems": [
          {
            "recordId": "45",
            "modId": "2",
            "LineItems::ProductName": "Widget A",
            "LineItems::Quantity": 3,
            "LineItems::Amount": 59.99
          }
        ]
      },
      "recordId": "12"
    }]
  }
}

Sorting records in Data API responses Executing FileMaker scripts via the Data API