{"_id":"564ce34f404ce53500fdb255","project":"563a252d50bf950d00e09798","version":{"_id":"563a252d50bf950d00e0979b","__v":7,"project":"563a252d50bf950d00e09798","createdAt":"2015-11-04T15:33:01.701Z","releaseDate":"2015-11-04T15:33:01.701Z","categories":["563a252e50bf950d00e0979c","563a2a691846790d008952fe","563a3394daf1c00d00136d9b","563a3467d25e8919005f3f0c","563a347850bf950d00e097b4","570e5cec10aa423200391fb5","5890d358d6cb8e2500a3f311"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"parentDoc":null,"__v":4,"category":{"_id":"563a252e50bf950d00e0979c","project":"563a252d50bf950d00e09798","pages":["563a252f50bf950d00e0979e","563a35ac1846790d0089532c","563d1407d8f2d20d00448d3c","563d1d3f9799fb0d0004776a","564509aa2c74cf1900da48c7","56453b7e9f3f550d00fa3c7b","564b498aeed7de0d003672c3","564b523ce5d9d61700d580e0","564b58ea1a8e610d006bfd49","564b59baee12850d00958656","564b6773d969330d00aba984","564b69b2d7b95d0d00ed050f","564b7fa8cc472d0d00da9447","564b905fa8a0ba21002ad6b1","564ba051288b1a2b00b3ae83","564ba6275cc43717009bcff1","564bb2138841060d00abb2e0","564bb74e05c99e1700161dd1","564c8ad60ddedc210051e582","564cca42d0c5b42b002305e8","564cca8ecfa4452b0019926d","564ce34f404ce53500fdb255","564cea76404ce53500fdb272","564cedb77d4d31170028dd2e","564cefc1bc81632100b10468","564cf17d1f42792b00820515","564cf5462248461700bd4017","564ddd49a8671617004e7b90","564ddf9ead1d5217003e2e18","564de1dea8671617004e7b99","564de3c11133043500f4bf96","564de669e39c4435005a1f65","564df3f16eaa3a2100868961","5655d3519347d30d00d7e8e2"],"version":"563a252d50bf950d00e0979b","__v":34,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-11-04T15:33:02.244Z","from_sync":false,"order":9999,"slug":"documentation","title":"Documentation"},"user":"54c7fdeae317000d007c2765","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-11-18T20:45:03.985Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":30,"body":"[block:api-header]\n{\n  \"type\": \"get\",\n  \"title\": \"GET /tabs\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Description\",\n    \"0-1\": \"Get a list of all the tabs to which the user has access.\",\n    \"1-0\": \"Permissions\",\n    \"2-0\": \"Resource URL\",\n    \"3-0\": \"Parameters\",\n    \"1-1\": \"dashboard.library\",\n    \"2-1\": \"https://app.klipfolio.com/api/1.0/tabs\",\n    \"3-1\": \"client_id (string) — show only tabs that belong to a specific client\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n##Example Request\n`GET https://app.klipfolio.com/api/1/tabs`\n\n##Example Response\n```\n{\n \"data\": {\n       \"id\": \"3c7b25bd388fc9a348d7c3e136986efb\",\n       \"name\": \"Examples\",\n       \"description\": \"Example Klips\"\n  },\n \"meta\": {\n     \"status\": 200,\n     \"success\": true\n }\n}\n```\n \n\n[block:api-header]\n{\n  \"type\": \"get\",\n  \"title\": \"GET /tabs/{id}\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Description\",\n    \"0-1\": \"Get the details for the specific tab.\",\n    \"1-0\": \"Permissions\",\n    \"2-0\": \"Resource URL\",\n    \"3-0\": \"Parameters\",\n    \"1-1\": \"dashboard.library\",\n    \"2-1\": \"https://app.klipfolio.com/api/1.0/tabs/{id}\",\n    \"3-1\": \"full (true/false) — include associations in the listing (klip_instances, share_rights)\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n##Example Request\n`GET https://app.klipfolio.com/api/1/tabs/012345679012345978abcd`\n\n##Example Response\n```\n{\n \"data\": {\n       \"id\": \"012345679012345978abcd\",\n        \"company\":\"What Inc.\",\n   \"name\":\"Examples\",\n   \"description\":”Example Klips”,\n   \"created_by\":\"2e21eda434a5169f9890576ec4d8e789\",\n   \"last_updated\":\"2014-11-13T21:38:27Z\"\n  },\n \"meta\": {\n     \"status\": 200,\n     \"success\": true\n }\n}\n```\n[block:api-header]\n{\n  \"type\": \"post\",\n  \"title\": \"POST /tabs\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Description\",\n    \"0-1\": \"Create a new tab.\",\n    \"1-0\": \"Permissions\",\n    \"2-0\": \"Resource URL\",\n    \"3-0\": \"Fields\",\n    \"1-1\": \"tab.build\",\n    \"2-1\": \"https://app.klipfolio.com/api/1.0/tabs\",\n    \"3-1\": \"name, description, client_id (optional)\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n##Example Request\n`POST https://app.klipfolio.com/api/1/tabs -d \"{'name':'New Tab', 'description':'This is a new tab'}\"`\n\n##Example Response\n```\n{\n  \"meta\": {\n     \"status\": 201,\n     \"success\": true,\n     “location”:”/tabs/ab123456789”\n }\n}\n```\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"PUT /tabs/{id}\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Description\",\n    \"0-1\": \"Update the specified tab.\",\n    \"1-0\": \"Permissions\",\n    \"2-0\": \"Resource URL\",\n    \"3-0\": \"Parameters\",\n    \"1-1\": \"tab.edit\",\n    \"2-1\": \"https://app.klipfolio.com/api/1.0/tabs/{id}\",\n    \"3-1\": \"full (true/false) — include associations in the listing (klip_instances, share_rights)\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n##Example Request\n`PUT https://app.klipfolio.com/api/1/tabs/abcde0123456 -d \"{'name':Update Tab', 'description':'Updated tab'}\"`\n\n##Example Response\n```\n{\n  \"meta\": {\n     \"status\": 200,\n     \"success\": true\n }\n}\n```\n[block:api-header]\n{\n  \"type\": \"delete\",\n  \"title\": \"DELETE /tabs/{id}\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Description\",\n    \"0-1\": \"Delete tab.\",\n    \"1-0\": \"Permissions\",\n    \"2-0\": \"Resource URL\",\n    \"3-0\": \"Parameters\",\n    \"1-1\": \"tab.delete\",\n    \"2-1\": \"https://app.klipfolio.com/api/1.0/tabs/{id}\",\n    \"3-1\": \"name, description\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n##Example Request\n`DELETE https://app.klipfolio.com/api/1/tabs/0987654321qwer`\n\n##Example Response\n```\n{\n\"meta\": {\n      \"status\": 200,\n      \"success\": true\n  }\n}\n```","excerpt":"View, create, update and manage tabs (dashboards) associated with the requesting company.","slug":"tabs-now-called-dashboards","type":"basic","title":"Tabs (now called dashboards)"}

Tabs (now called dashboards)

View, create, update and manage tabs (dashboards) associated with the requesting company.

[block:api-header] { "type": "get", "title": "GET /tabs" } [/block] [block:parameters] { "data": { "0-0": "Description", "0-1": "Get a list of all the tabs to which the user has access.", "1-0": "Permissions", "2-0": "Resource URL", "3-0": "Parameters", "1-1": "dashboard.library", "2-1": "https://app.klipfolio.com/api/1.0/tabs", "3-1": "client_id (string) — show only tabs that belong to a specific client" }, "cols": 2, "rows": 4 } [/block] ##Example Request `GET https://app.klipfolio.com/api/1/tabs` ##Example Response ``` { "data": { "id": "3c7b25bd388fc9a348d7c3e136986efb", "name": "Examples", "description": "Example Klips" }, "meta": { "status": 200, "success": true } } ```   [block:api-header] { "type": "get", "title": "GET /tabs/{id}" } [/block] [block:parameters] { "data": { "0-0": "Description", "0-1": "Get the details for the specific tab.", "1-0": "Permissions", "2-0": "Resource URL", "3-0": "Parameters", "1-1": "dashboard.library", "2-1": "https://app.klipfolio.com/api/1.0/tabs/{id}", "3-1": "full (true/false) — include associations in the listing (klip_instances, share_rights)" }, "cols": 2, "rows": 4 } [/block] ##Example Request `GET https://app.klipfolio.com/api/1/tabs/012345679012345978abcd` ##Example Response ``` { "data": { "id": "012345679012345978abcd", "company":"What Inc.", "name":"Examples", "description":”Example Klips”, "created_by":"2e21eda434a5169f9890576ec4d8e789", "last_updated":"2014-11-13T21:38:27Z" }, "meta": { "status": 200, "success": true } } ``` [block:api-header] { "type": "post", "title": "POST /tabs" } [/block] [block:parameters] { "data": { "0-0": "Description", "0-1": "Create a new tab.", "1-0": "Permissions", "2-0": "Resource URL", "3-0": "Fields", "1-1": "tab.build", "2-1": "https://app.klipfolio.com/api/1.0/tabs", "3-1": "name, description, client_id (optional)" }, "cols": 2, "rows": 4 } [/block] ##Example Request `POST https://app.klipfolio.com/api/1/tabs -d "{'name':'New Tab', 'description':'This is a new tab'}"` ##Example Response ``` { "meta": { "status": 201, "success": true, “location”:”/tabs/ab123456789” } } ``` [block:api-header] { "type": "basic", "title": "PUT /tabs/{id}" } [/block] [block:parameters] { "data": { "0-0": "Description", "0-1": "Update the specified tab.", "1-0": "Permissions", "2-0": "Resource URL", "3-0": "Parameters", "1-1": "tab.edit", "2-1": "https://app.klipfolio.com/api/1.0/tabs/{id}", "3-1": "full (true/false) — include associations in the listing (klip_instances, share_rights)" }, "cols": 2, "rows": 4 } [/block] ##Example Request `PUT https://app.klipfolio.com/api/1/tabs/abcde0123456 -d "{'name':Update Tab', 'description':'Updated tab'}"` ##Example Response ``` { "meta": { "status": 200, "success": true } } ``` [block:api-header] { "type": "delete", "title": "DELETE /tabs/{id}" } [/block] [block:parameters] { "data": { "0-0": "Description", "0-1": "Delete tab.", "1-0": "Permissions", "2-0": "Resource URL", "3-0": "Parameters", "1-1": "tab.delete", "2-1": "https://app.klipfolio.com/api/1.0/tabs/{id}", "3-1": "name, description" }, "cols": 2, "rows": 4 } [/block] ##Example Request `DELETE https://app.klipfolio.com/api/1/tabs/0987654321qwer` ##Example Response ``` { "meta": { "status": 200, "success": true } } ```