View, update and manage tab (now called dashboard) instances. An instance is a copy of one tab that is in a user's account; a dashboard is a collection of tab instances.

GET /users/{id}/tab-instances

Description

Retrieve a list of the user’s tab instances.

Permissions

user.manage

Resource URL

https://app.klipfolio.com/api/1.0/users/{id}/tab-instances

Parameters

user id={id}, roles id={id}

Example Request

GET https://app.klipfolio.com/api/1/users/fedcba9876543210fedcba9876543210/tab-instances

Example Response

{
  "meta": {
    "success": true,
    "status": 200
  },
  "data": {
    "tab_instances": [
      {
        "id": "789ae076049d6b835200ea2419411d4c",
        "tab_id": "cf66f1679068052446987c9ec99d3e91",
        "name": "Adwords",
        "context": "desktop"
      },
      {
        "id": "81740be2e4746a4bb79dd0aab3cc4652",
        "tab_id": "a538858966297b776216141579bb0dbe",
        "name": "API Tab",
        "context": "desktop"
      }
 ]
}

PUT /users/{id}/tab-instances

Description

Add one or more tabs to a user’s dashboard. Use tab IDs not tab instance IDs.

Permissions

user.manage

Resource URL

https://app.klipfolio.com/api/1.0/users/{id}/tab-instances

Fields

tab_ids

Example Request

PUT https://app.klipfolio.com/api/1.0/users/ab8c07b4d6bb53acd1234567c36213be/tab-instances -d {"tab_ids": ["ab12a34580678e912d9c365e12b1bc"]}

Example Response

{
  "meta": {
    "success": true,
    "status": 200
  },
  "data": {
    "tab_instances": [
      {
        "id": "4a123b834414868061a9045a3750abcd",
        "tab_id": "ab12a34580678e912d9c365e12b1bc",
        "name": "HTML Test"
      }
    ]
  }
}

DELETE /users/{id}/tab-instances/{id}

Description

Delete a user’s tab instance.

Permissions

user.manage

Resource URL

https://app.klipfolio.com/api/1.0/users/{id}/tab-instances/{tabInstanceId}

Parameters

None.

Example Request

DELETE https://app.klipfolio.com/api/1/users/0123456789abc/tab-instances/0123456789abc
##Example Response

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