---
title: Get Layout
slug: get-layout
docTags: 
createdAt: 2026-08-25T19:28:59.170Z
---

{
  "id": "cukiehGHFs8Z3WUKe11AJ",
  "type": "api-oas-v2",
  "data": {
    "method": "GET",
    "url": "https://api.nue.io/metadata/layouts/{layoutApiName}",
    "servers": [
      {
        "url": "https://api.nue.io/metadata/layouts/{layoutApiName}",
        "description": "Nue Production API Endpoint"
      },
      {
        "url": "https://api.sandbox.nue.io/metadata/layouts/{layoutApiName}",
        "description": "Nue Sandbox API Endpoint"
      }
    ],
    "name": "Get Layout",
    "description": "Retrieve the complete configuration and metadata for a specific layout by its API name.",
    "contentType": "application/json",
    "request": {
      "pathParameters": [
        {
          "kind": "required",
          "name": "layoutApiName",
          "type": "string",
          "example": "OrderFormLayout",
          "description": "The API name of the layout to retrieve"
        }
      ],
      "headerParameters": [
        {
          "name": "accept",
          "type": "string",
          "kind": "optional",
          "description": "Generated from available response content types",
          "enum": [
            "application/json"
          ],
          "default": "application/json"
        }
      ],
      "queryParameters": [],
      "bodyDataParameters": [],
      "formDataParameters": [],
      "oAuthParameters": [
        {
          "id": "apiKeyAuth",
          "name": "nue-api-key",
          "kind": "optional",
          "type": "apiKey",
          "in": "header"
        }
      ],
      "cookieParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "OK",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "GetLayoutDetailResponse",
            "schema": [
              {
                "name": "status",
                "kind": "optional",
                "type": "string<Succeeded | Failed>",
                "description": "",
                "enum": [
                  "Succeeded",
                  "Failed"
                ]
              },
              {
                "name": "message",
                "kind": "optional",
                "type": "string",
                "description": ""
              },
              {
                "name": "layout",
                "kind": "optional",
                "type": "object",
                "description": "",
                "modelRef": "#/components/schemas/LayoutDetailInfo",
                "customType": "LayoutDetailInfo",
                "schema": [
                  {
                    "name": "type",
                    "kind": "optional",
                    "type": "string<FormView | ListView | SearchView>",
                    "description": "",
                    "enum": [
                      "FormView",
                      "ListView",
                      "SearchView"
                    ]
                  },
                  {
                    "name": "apiName",
                    "kind": "optional",
                    "type": "string",
                    "description": ""
                  },
                  {
                    "name": "name",
                    "kind": "optional",
                    "type": "string",
                    "description": ""
                  },
                  {
                    "name": "objectApiName",
                    "kind": "optional",
                    "type": "string",
                    "description": ""
                  },
                  {
                    "name": "contentChecksum",
                    "kind": "optional",
                    "type": "string",
                    "description": ""
                  },
                  {
                    "name": "layoutStatus",
                    "kind": "optional",
                    "type": "string<Draft | Active | Inactive>",
                    "description": "",
                    "enum": [
                      "Draft",
                      "Active",
                      "Inactive"
                    ]
                  },
                  {
                    "name": "tags",
                    "kind": "optional",
                    "type": "array",
                    "description": "",
                    "example": "",
                    "itemType": "string",
                    "customType": "string[]",
                    "itemExample": "",
                    "itemDefault": ""
                  },
                  {
                    "name": "content",
                    "kind": "optional",
                    "type": "string",
                    "description": ""
                  }
                ]
              }
            ],
            "modelRef": "#/components/schemas/GetLayoutDetailResponse",
            "isExpanded": true
          }
        ]
      }
    ],
    "hasXCodeSamples": false,
    "examples": {
      "languages": [
        {
          "id": "uQONr7no-09wjgF9ZzYEg",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request GET \\\n     --url https://api.nue.io/metadata/layouts/{layoutApiName} \\\n     --header 'accept: application/json'"
        },
        {
          "id": "w3Z3uED1GK1Q7XbXY79fh",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n   method: 'GET',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch(\"https://api.nue.io/metadata/layouts/{layoutApiName}\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "1EJgDCQAGbNOCbQLh04Fd",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.nue.io/metadata/layouts/{layoutApiName}\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n"
        },
        {
          "id": "7_xlrJtQzEReXVJWw895_",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://api.nue.io/metadata/layouts/{layoutApiName}\"\n\npayload = {}\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "uQONr7no-09wjgF9ZzYEg"
    },
    "results": {
      "languages": [
        {
          "id": "1Gc0awHmQghre8BE8DPcx",
          "language": "200",
          "code": "// OK\n{\n  \"status\": \"\",\n  \"message\": \"\",\n  \"layout\": {\n    \"type\": \"\",\n    \"apiName\": \"\",\n    \"name\": \"\",\n    \"objectApiName\": \"\",\n    \"contentChecksum\": \"\",\n    \"layoutStatus\": \"\",\n    \"tags\": [\n      \"\"\n    ],\n    \"content\": \"\"\n  }\n}"
        }
      ],
      "selectedLanguageId": "1Gc0awHmQghre8BE8DPcx"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}