Using the metadata endpoint to inspect layout fields

Intermediate

Call GET /layouts/{layout}/metadata to discover which fields and portals are available on a layout, including field types and whether they are editable.

What you'll learn

  • How to call the metadata endpoint and what it returns
  • How to read field names and types from the response
  • How to use metadata to build dynamic integrations that adapt to layout changes

The metadata endpoint lets you introspect a layout at runtime — discovering field names, data types, and portal structures without needing access to FileMaker Pro.

1/3
1

Call the metadata endpoint

Send a GET request to /layouts/{layout}/metadata. No request body is needed. A valid session token is still required.

HTTP
GET /fmi/data/v1/databases/{db}/layouts/Customers/metadata
Authorization: Bearer {token}
Uploading a file to a container field via the Data APIData API best practices: sessions, scripts, and rate limits

Sign in to track your progress and pick up where you left off.

Sign in to FM Dojo