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

GET /tabs

Description

Get a list of all the tabs to which the user has access.

Permissions

dashboard.library

Resource URL

https://app.klipfolio.com/api/1.0/tabs

Parameters

client_id (string) — show only tabs that belong to a specific client

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

GET /tabs/{id}

Description

Get the details for the specific tab.

Permissions

dashboard.library

Resource URL

https://app.klipfolio.com/api/1.0/tabs/{id}

Parameters

full (true/false) — include associations in the listing (klip_instances, share_rights)

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

POST /tabs

Description

Create a new tab.

Permissions

tab.build

Resource URL

https://app.klipfolio.com/api/1.0/tabs

Fields

name, description, client_id (optional)

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

PUT /tabs/{id}

Description

Update the specified tab.

Permissions

tab.edit

Resource URL

https://app.klipfolio.com/api/1.0/tabs/{id}

Parameters

full (true/false) — include associations in the listing (klip_instances, share_rights)

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

DELETE /tabs/{id}

Description

Delete tab.

Permissions

tab.delete

Resource URL

https://app.klipfolio.com/api/1.0/tabs/{id}

Parameters

name, description

Example Request

DELETE https://app.klipfolio.com/api/1/tabs/0987654321qwer

Example Response

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