Including portal records in Data API responses

Intermediate

Request related child records alongside the parent by specifying portal names in your Data API call, and learn how to paginate within a portal.

What you'll learn

How to request portal data using portal object names
How portal records are structured inside the response
How to paginate within a portal using _offset.portalName and _limit.portalName

The Data API can return related records from one or more portals alongside the parent record by including a "portals" array in the request.

1/3

Request portal data by portal object name

Add a "portals" array to your GET or POST request body. Each element is the object name of a portal on the layout (not the table name — the portal's object name set in the Inspector).

HTTP

GET /fmi/data/v1/databases/{db}/layouts/Customers/records/42
    ?portal=["LineItems","Contacts"]
Authorization: Bearer {token}

Sorting Data API results with the sort parameter Interpreting and handling Data API error codes