Guides
API Reference

Tab Layout

Change the layout schema of a tab (now called a dashboard).

GET /tabs/{id}/layout

DescriptionGet the layout of a tab.
Permissionsdashboard.share
Resource URLhttps://app.klipfolio.com/api/1.0/tabs/{id}/layout
Parameterstab id={id}

Example Request

GET https://app.klipfolio.com/api/1/tabs/fedcba9876543210fedcba9876543210/layout

Example Response

{
 "data": {
     "type": "30_60",
     "state": {
         "0123457890123456789abcde":{"region":"region-1","idx":0},
         ...
        }
  },
 "meta": {
     "status": 200,
     "success": true
 }
}

PUT /tabs/{id}/layout

DescriptionUpdate the layout of the tab. The layout “type” refers to the size and number of Klip columns on the tab. The layout “state” is a JSON object representing the position of each Klip on the tab.
Permissionsdashboard.share
Resource URLhttps://app.klipfolio.com/api/1.0/tabs/{id}/layout
Fieldstab id={id}

Example Request

PUT https://app.klipfolio.com/api/1/tabs/fedcba9876543210fedcba9876543210/layout -d "{'type':'100', 'state':{'04462abd3a38372173645f3b50128596':{'region': 'region-1', 'idx': 1}}}"

Example Response

{
 "meta": {
     "status": 200,
     "success": true
 }
}