User Tab Instances

GET /users/{id}/tab-instances


Description	Retrieve a list of the user’s tab instances in your company or client account.
Permissions	user.manage
Resource URL	https://app.klipfolio.com/api/1.0/users/{id}/tab-instances
Parameters	user id={id} optional: client_id

Example Request

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

GET https://app.klipfolio.com/api/1/users/fedcba9876543210fedcba9876543210/tab-instances?client_id=0123456789abcdef0123456789abcdef

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 in your company or client account. 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 optional: client_id

Example Request

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

PUT https://app.klipfolio.com/api/1/users/fedcba9876543210fedcba9876543210/tab-instances?client_id=0123456789abcdef0123456789abcdef -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 in your company or client account.
Permissions	user.manage
Resource URL	https://app.klipfolio.com/api/1.0/users/{id}/tab-instances/{tabInstanceId}
Parameters	tab_instance_id optional: client_id

Example Request

PUT https://app.klipfolio.com/api/1/users/fedcba9876543210fedcba9876543210/tab-instances/0123456789abc

PUT https://app.klipfolio.com/api/1/users/fedcba9876543210fedcba9876543210/tab-instances/0123456789abc?client_id=0123456789abcdef0123456789abcdef

Example Response

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