Get layout names

To retrieve the layout names of all available layouts for a specified database, use an HTTP GET method with the layouts API endpoint.

HTTP method

GET

URL

Format: /fmi/data/version/databases/database-name/layouts

version – the FileMaker Data API version requested can use v1, v2, or vLatest

database-name – the name of the hosted database

HTTP header

Authorization: Bearer session-token, where session-token is the unique X-FM-Data-Access-Token value for the database session
Parameters None
Response

A layouts array listing the layout names, and a messages array showing an error code of 0.

For example:

Copy 
{
  "messages": [
    {
      "message": "OK", 
      "code": "0"
    }
  ], 
 "response": {
    "layouts": [
      {
        "name": "Customers"
      }, 
      {
        "name": "Details"
      }, 
      {
        "folderLayoutNames": [
          {
            "name": "Mark as sent"
          }, 
          {
            "name": "Find Unsent"
          }
        ], 
        "isFolder": true, 
        "name": "Package Management"
      } 
    ]
  }
}

See Error responses.