Tabs (now called dashboards)

GET /tabs


Description	Get a list of all the tabs in the company or client account.
Permissions	dashboard.library
Resource URL	https://app.klipfolio.com/api/1.0/tabs
Parameters	optional: client_id

Example Request

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

GET https://app.klipfolio.com/api/1/tabs?client_id=0123456789abcdef0123456789abcdef

Example Response

{
 "data": {
       "id": "3c7b25bd388fc9a348d7c3e136986efb",
       "name": "Examples",
       "description": "Example Klips"
  },
 "meta": {
     "status": 200,
     "success": true
 }
}

GET /tabs/{id}


Description	Get the details for the specific tab in the company or client account.
Permissions	dashboard.library
Resource URL	https://app.klipfolio.com/api/1.0/tabs/{id}
Parameters	dashboard_id full (true/false) — include associations in the listing (klip_instances, share_rights) optional: client_id

Example Request

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

GET https://app.klipfolio.com/api/1/tabs/fedcba9876543210fedcba9876543210?full=true

GET https://app.klipfolio.com/api/1/tabs/fedcba9876543210fedcba9876543210?client_id=0123456789abcdef0123456789abcdef

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
 }
}

{
 "data": {
       "id": "012345679012345978abcd",
        "company":"What Inc.",
   "name":"Examples",
   "description":”Example Klips”,
   "created_by":"2e21eda434a5169f9890576ec4d8e789",
   "last_updated":"2014-11-13T21:38:27Z"
   "klip_instances": [
            "24164f70bb49868c76de94dc684d1eaf"
        ],
        "share_rights": [],
        "user_share_rights": [
            {
                "user_id": "abcd15a2c4e92a995f2c1b89b829ffd8",
                "first_name": "User A",
                "last_name": "Last Name",
                "can_edit": true
            }
        ]
    },
 "meta": {
     "status": 200,
     "success": true
 }
}

POST /tabs


Description	Create a new tab in the company or client account.
Permissions	tab.build
Resource URL	https://app.klipfolio.com/api/1.0/tabs
Fields	name, description optional: client_id

Example Request

POST https://app.klipfolio.com/api/1/tabs -d {'name':'New Title', 'description':'This is a new dashboard'}

POST https://app.klipfolio.com/api/1/tabs/fedcba9876543210fedcba9876543210 -d {'client_id':'0123456789abcdef0123456789abcdef', 
 'name':'New Title', 
 'description':'This is a new dashboard'}

Example Response

{
  "meta": {
     "status": 201,
     "success": true,
     “location”:”/tabs/ab123456789”
 }
}

PUT /tabs/{id}


Description	Update the specified tab in the company or client account.
Permissions	tab.edit
Resource URL	https://app.klipfolio.com/api/1.0/tabs/{id}
Parameters	dashboard_id name, description optional: client_id

Example Request

PUT https://app.klipfolio.com/api/1/tabs -d {'name':'Updated Title', 'description':'This is updated'}

PUT https://app.klipfolio.com/api/1/tabs/fedcba9876543210fedcba9876543210?client_id=0123456789abcdef0123456789abcdef -d {'name':'Updated Tab', 'description':'This is updated'}

Example Response

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

DELETE /tabs/{id}


Description	Delete tab from the company or client account.
Permissions	tab.delete
Resource URL	https://app.klipfolio.com/api/1.0/tabs/{id}
Parameters	dashboard_id optional: client_id

Example Request

DELETE https://app.klipfolio.com/api/1/tabs/fedcba9876543210fedcba9876543210

DELETE https://app.klipfolio.com/api/1/tabs/fedcba9876543210fedcba9876543210?client_id=0123456789abcdef0123456789abcdef

Example Response

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