---
updatedAt: 2026-05-29T17:52:38.000Z
agentTools:
  projectIndex: https://apidocs.klipfolio.com/llms.txt
---

# User Tab Instances

View, update and manage tab (now called dashboard) instances in your account or your client accounts. 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

<Table align={["left","left"]}>
  <thead>
    <tr>
      <th style={{ textAlign: "left" }}>

      </th>

      <th style={{ textAlign: "left" }}>

      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td style={{ textAlign: "left" }}>
        Description
      </td>

      <td style={{ textAlign: "left" }}>
        Retrieve a list of the user’s tab instances in your company or client account.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        Permissions
      </td>

      <td style={{ textAlign: "left" }}>
        user.manage
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        Resource URL
      </td>

      <td style={{ textAlign: "left" }}>
        [https://app.klipfolio.com/api/1.0/users/\{id}/tab-instances](https://app.klipfolio.com/api/1.0/users/\{id}/tab-instances)
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        Parameters
      </td>

      <td style={{ textAlign: "left" }}>
        user id=\{id}  
        optional: client_id
      </td>
    </tr>
  </tbody>
</Table>

## Example Request

```Text Get tab instances for user
GET https://app.klipfolio.com/api/1/users/fedcba9876543210fedcba9876543210/tab-instances
```
```Text Client get tab instances for user
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

<Table align={["left","left"]}>
  <thead>
    <tr>
      <th>

      </th>

      <th>

      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        Description
      </td>

      <td>
        Add one or more tabs to a user’s dashboard in your company or client account. Use tab IDs not tab instance IDs.
      </td>
    </tr>

    <tr>
      <td>
        Permissions
      </td>

      <td>
        user.manage
      </td>
    </tr>

    <tr>
      <td>
        Resource URL
      </td>

      <td>
        [https://app.klipfolio.com/api/1.0/users/\{id}/tab-instances](https://app.klipfolio.com/api/1.0/users/\{id}/tab-instances)
      </td>
    </tr>

    <tr>
      <td>
        Fields
      </td>

      <td>
        tab_ids  
        optional: client_id
      </td>
    </tr>
  </tbody>
</Table>

## Example Request

```Text Add tab instances to user
PUT https://app.klipfolio.com/api/1/users/fedcba9876543210fedcba9876543210/tab-instances -d {"tab_ids": ["ab12a34580678e912d9c365e12b1bc"]}
```
```Text Client add tab instances to user
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}

<Table align={["left","left"]}>
  <thead>
    <tr>
      <th>

      </th>

      <th>

      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        Description
      </td>

      <td>
        Delete a user’s tab instance in your company or client account.
      </td>
    </tr>

    <tr>
      <td>
        Permissions
      </td>

      <td>
        user.manage
      </td>
    </tr>

    <tr>
      <td>
        Resource URL
      </td>

      <td>
        [https://app.klipfolio.com/api/1.0/users/\{id}/tab-instances/\{tabInstanceId}](https://app.klipfolio.com/api/1.0/users/\{id}/tab-instances/\{tabInstanceId})
      </td>
    </tr>

    <tr>
      <td>
        Parameters
      </td>

      <td>
        tab_instance_id   
        optional: client_id
      </td>
    </tr>
  </tbody>
</Table>

## Example Request

```Text Delete tab instance from user
PUT https://app.klipfolio.com/api/1/users/fedcba9876543210fedcba9876543210/tab-instances/0123456789abc
```
```Text Client delete tab instance from user
PUT https://app.klipfolio.com/api/1/users/fedcba9876543210fedcba9876543210/tab-instances/0123456789abc?client_id=0123456789abcdef0123456789abcdef
```

## Example Response

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