Tab Share Rights

GET /tabs/{id}/share-rights


Description	Get a list of the tab’s share rights in the company or client account.
Permissions	tab.share
Resource URL	https://app.klipfolio.com/api/1/tabs/{id}/share-rights
Parameters	tab_id (string) optional: client_id

Example Request

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

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

Example Response

{
 "data": {
       "share_rights":[{
          "group_id":"f3db5f3a05d53c60032ec0730759a785",
          "group_name":"First Test Group",
          "can_edit":false
          "vis_dashboard":"dashboard"
         }]
  },
 "meta": {
     "status": 200,
     "success": true
 }
}

PUT /tabs/{id}/share-rights


Description	Update a tab's share rights in the company or client account. If the tab is not already shared with the specified group or user, a new share right is created, otherwise the existing right is updated.
Permissions	tab.share
Resource URL	https://app.klipfolio.com/api/1.0/tabs/{id}/share-rights
Fields	group_id, user_id, can_edit (true/false) optional: client_id

Example Request

PUT https://app.klipfolio.com/api/1/tabs/fedcba9876543210fedcba9876543210/share-rights 
-d {'groups': [{'group_id': 'a9dff9e0b37ecd0fff24cba32ab88223', 'can_edit': true}, {'group_id': 'c4283e83f928255074e7c1aa3c35c30b', 'can_edit': false}]}

PUT https://app.klipfolio.com/api/1/tabs/fedcba9876543210fedcba9876543210/share-rights 
-d {'users': [{'user_id': 'a9dff9e0b37ecd0fff24cba32ab88223', 'can_edit': true}]}

PUT https://app.klipfolio.com/api/1/tabs/fedcba9876543210fedcba9876543210/share-rights?client_id=0123456789abcdef0123456789abcdef 
-d {'groups': [{'group_id': 'a9dff9e0b37ecd0fff24cba32ab88223', 'can_edit': true}, {'group_id': 'c4283e83f928255074e7c1aa3c35c30b', 'can_edit': false}]}

Example Response

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

DELETE /tabs/{id}/share-rights/{group-id}


Description	Revoke access to a group tab in the company or client account.
Permissions	tab.share
Resource URL	https://app.klipfolio.com/api/1.0/tabs/{id}/share-rights/{group_id}
Parameters	group_id optional: client_id

Example Request

DELETE https://app.klipfolio.com/api/1/tabs/fedcba9876543210fedcba9876543210/share-rights/a9dff9e0b37ecd0fff24cba32ab88223

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

Example Response

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