Connect AI agents to Klipfolio

Scalekit connector

The Klipfolio connector lets your AI agent act in each user's Klipfolio account. Each user connects their own Klipfolio API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 59 tools.

Tools: 59
What they doRead · write · destructive: 29 · 22 · 829 read22 write8 destructive
Users sign in with: API key

Setup

Install the SDK
- Node.js
- Python
Terminal window
npm install @scalekit-sdk/node dotenv
Terminal window
pip install scalekit-sdk-python python-dotenv
Set your credentials
Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.
.env
```
SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
SCALEKIT_CLIENT_ID=<your-client-id>
SCALEKIT_CLIENT_SECRET=<your-client-secret>
```
Create the Klipfolio connection
In AgentKit > Connections, create a Klipfolio connection. The name you give it is the connection_name your code passes. See Configure connections.

Authorize a user and make your first call

Node.js
Python

1
import { ScalekitClient } from '@scalekit-sdk/node'
2
import 'dotenv/config'
3
import { createInterface } from 'node:readline/promises'
4

5
const scalekit = new ScalekitClient(
6
  process.env.SCALEKIT_ENVIRONMENT_URL,
7
  process.env.SCALEKIT_CLIENT_ID,
8
  process.env.SCALEKIT_CLIENT_SECRET,
9
)
10
const actions = scalekit.actions
11

12
const connector = 'klipfolio'
13
const identifier = 'user_123'
14

15
// Generate an authorization link for the user
16
const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
17
console.log('Authorize Klipfolio:', link)
18
const rl = createInterface({ input: process.stdin, output: process.stdout })
19
await rl.question('Press Enter after authorizing...')
20
rl.close()
21

22
// Make your first call
23
const result = await actions.executeTool({
24
  connector,
25
  identifier,
26
  toolName: 'klipfolio_clients_list',
27
  toolInput: {},
28
})
29
console.log(result)

npx tsx quickstart.mts

1
import os
2
from scalekit import ScalekitClient
3
from dotenv import load_dotenv
4
load_dotenv()
5

6
scalekit_client = ScalekitClient(
7
    env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
8
    client_id=os.getenv("SCALEKIT_CLIENT_ID"),
9
    client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
10
)
11
actions = scalekit_client.actions
12

13
connection_name = "klipfolio"
14
identifier = "user_123"
15

16
# Generate an authorization link for the user
17
link_response = actions.get_authorization_link(
18
    connection_name=connection_name,
19
    identifier=identifier,
20
)
21
print("Authorize Klipfolio:", link_response.link)
22
input("Press Enter after authorizing...")
23

24
# Make your first call
25
result = actions.execute_tool(
26
    tool_input={},
27
    tool_name="klipfolio_clients_list",
28
    connection_name=connection_name,
29
    identifier=identifier,
30
)
31
print(result)

python quickstart.py

Each user opens the link once and enters their Klipfolio credentials there. See Authorize a user for the full flow and statuses.

Tools

Pass the exact name to execute_tool

Try in Playground Request a tool

klipfolio_client_getGet one client account by ID.Read-only
Get Client
Get one client account by ID. Returns its id, name, description, status, seats, billing and trial details; with full=true also its user and group IDs and share rights. Use klipfolio_client_get when you know the client ID. Use klipfolio_clients_list to find it.
Inputs
client_idstringrequired
ID of the client account. Get it from the id field of klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
fullboolean
Set to true to include associations in the response (users, groups, share_right). Default false.
klipfolio_clients_listList the client accounts managed by a partner Klipfolio account, optionally by status or external ID.Read-only
List Clients
List the client accounts managed by a partner Klipfolio account, optionally by status or external ID. Returns each client's id, name, description, status, seats and last sign-in date. Use klipfolio_clients_list to find a client_id for the other tools. Use klipfolio_client_get for one client's users and groups.
Inputs
external_idstring
Only return clients with this external ID. Example: "acct-77".
limitinteger
Maximum number of results to return. Default 25, maximum 100 (values over 100 return a 400 error). Example: 50.
offsetinteger
Index of the first result to return, for paging. Default 0. Example: 25 returns the second page when limit is 25.
statusstring
Only return clients with this account status: active, trial, setup or disabled.one of activetrialsetupdisabled
klipfolio_dashboard_getGet one dashboard (tab) by ID.Read-only
Get Dashboard
Get one dashboard (tab) by ID. Returns its id, name, description, company, creator and last-updated date; with full=true also its Klip instance IDs and group and user share rights. Use klipfolio_dashboard_get when you know the dashboard ID. Use klipfolio_dashboard_klip_instances_list for the Klips on it with their names.
Inputs
dashboard_idstringrequired
ID of the dashboard (called a tab in the Klipfolio API). Get it from the id field of klipfolio_dashboards_list. Example: "fedcba9876543210fedcba9876543210".
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
fullboolean
Set to true to include associations in the response (klip_instances, share_rights). Default false.
klipfolio_dashboard_klip_instances_listList the Klip instances placed on a dashboard (tab).Read-only
List Dashboard Klips
List the Klip instances placed on a dashboard (tab). Returns each instance's id, the source klip_id and the Klip name. Use klipfolio_dashboard_klip_instances_list to see what a dashboard shows or to find an instance ID for klipfolio_dashboard_klip_instance_remove.
Inputs
dashboard_idstringrequired
ID of the dashboard (called a tab in the Klipfolio API). Get it from the id field of klipfolio_dashboards_list. Example: "fedcba9876543210fedcba9876543210".
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
klipfolio_dashboard_layout_getGet the layout of a dashboard (tab): its layout type and where each Klip sits.Read-only
Get Dashboard Layout
Get the layout of a dashboard (tab): its layout type and where each Klip sits. Returns type and state, where state holds per-context grid settings and one entry per Klip with its column span, position and height. Use klipfolio_dashboard_layout_get before klipfolio_dashboard_layout_update, because the update must include every Klip.
Inputs
dashboard_idstringrequired
ID of the dashboard (called a tab in the Klipfolio API). Get it from the id field of klipfolio_dashboards_list. Example: "fedcba9876543210fedcba9876543210".
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
klipfolio_dashboard_share_rights_getList who a dashboard (tab) is shared with.Read-only
Get Dashboard Share Rights
List who a dashboard (tab) is shared with. Returns share_rights entries with group_id, group_name and can_edit. Use klipfolio_dashboard_share_rights_get to audit access. Use klipfolio_dashboard_share_rights_update to grant or change access.
Inputs
dashboard_idstringrequired
ID of the dashboard (called a tab in the Klipfolio API). Get it from the id field of klipfolio_dashboards_list. Example: "fedcba9876543210fedcba9876543210".
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
klipfolio_dashboards_listList the dashboards (called tabs in the Klipfolio API) in the company or a client account.Read-only
List Dashboards
List the dashboards (called tabs in the Klipfolio API) in the company or a client account. Returns each dashboard's id, name and description, 25 per page by default. Use klipfolio_dashboards_list to browse or find dashboard IDs. Use klipfolio_dashboard_get for one dashboard's Klips and share rights.
Inputs
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
limitinteger
Maximum number of results to return. Default 25, maximum 100 (values over 100 return a 400 error). Example: 50.
offsetinteger
Index of the first result to return, for paging. Default 0. Example: 25 returns the second page when limit is 25.
klipfolio_datasource_getGet one data source by ID.Read-only
Get Data Source
Get one data source by ID. Returns its id, name, description, connector, format, refresh interval, creator, dynamic and disabled flags, and created and last-refresh dates. Use klipfolio_datasource_get when you know the ID. Use klipfolio_datasource_properties_get for its connection settings such as the endpoint URL.
Inputs
datasource_idstringrequired
ID of the data source. Get it from the id field of klipfolio_datasources_list. Example: "c98bad42a8c8a63e0b5e6c0f7aca9898".
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
klipfolio_datasource_instance_data_getGet the data currently stored in a data source instance, in the data source's own format (for example CSV, JSON or XML).Read-only
Get Data Source Instance Data
Get the data currently stored in a data source instance, in the data source's own format (for example CSV, JSON or XML). Returns the raw data as text. Use klipfolio_datasource_instance_data_get to read what a Klip is built on. Use klipfolio_datasource_instance_refresh first if the data may be stale.
Inputs
instance_idstringrequired
ID of the data source instance. A data source that is not dynamic has one instance with the same ID as the data source; dynamic data sources have several. Get it from the id field of klipfolio_datasource_instances_list. Example: "4928fb1d95bfb4e02012de483c1234a5".
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
klipfolio_datasource_instance_getGet one data source instance by ID.Read-only
Get Data Source Instance
Get one data source instance by ID. Returns its id, datasource_id, data source name, last and next refresh dates (UTC), refresh failure count and data size. Use klipfolio_datasource_instance_get to check refresh status. Use klipfolio_datasource_instance_data_get for the data itself.
Inputs
instance_idstringrequired
ID of the data source instance. A data source that is not dynamic has one instance with the same ID as the data source; dynamic data sources have several. Get it from the id field of klipfolio_datasource_instances_list. Example: "4928fb1d95bfb4e02012de483c1234a5".
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
klipfolio_datasource_instances_listList data source instances, optionally only those of one data source.Read-only
List Data Source Instances
List data source instances, optionally only those of one data source. Returns each instance's id, datasource_id, data source name, data size, refresh failure count and last refresh date. Use klipfolio_datasource_instances_list to find instance IDs, especially for dynamic data sources that have several. Use klipfolio_datasource_instance_get for one instance.
Inputs
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
datasource_idstring
Only return instances of this data source. Use the data source ID (from klipfolio_datasources_list), not an instance ID. Example: "4928fb1d95bfb4e02012de483c1234a5".
limitinteger
Maximum number of results to return. Default 25, maximum 100 (values over 100 return a 400 error). Example: 50.
offsetinteger
Index of the first result to return, for paging. Default 0. Example: 25 returns the second page when limit is 25.
klipfolio_datasource_properties_getGet the connection properties of a data source, such as its endpoint URL and method; the keys depend on the connector.Read-only
Get Data Source Properties
Get the connection properties of a data source, such as its endpoint URL and method; the keys depend on the connector. Returns a properties object. Use klipfolio_datasource_properties_get to see how a data source fetches its data. Use klipfolio_datasource_get for name, connector and refresh status.
Inputs
datasource_idstringrequired
ID of the data source. Get it from the id field of klipfolio_datasources_list. Example: "c98bad42a8c8a63e0b5e6c0f7aca9898".
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
klipfolio_datasource_share_rights_getList who a data source is shared with.Read-only
Get Data Source Share Rights
List who a data source is shared with. Returns share_rights (group_id, group_name, can_edit) and user_share_rights (user_id, first and last name, can_edit). Use klipfolio_datasource_share_rights_get to audit access. Use klipfolio_datasource_share_rights_update to grant or change it.
Inputs
datasource_idstringrequired
ID of the data source. Get it from the id field of klipfolio_datasources_list. Example: "c98bad42a8c8a63e0b5e6c0f7aca9898".
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
klipfolio_datasources_listList the data sources the user can access.Read-only
List Data Sources
List the data sources the user can access. Returns each data source's id, name, description, refresh interval, last refresh date and whether it is dynamic, 25 per page by default. Use klipfolio_datasources_list to browse or find data source IDs. Use klipfolio_datasource_get for connector, format and status details.
Inputs
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
limitinteger
Maximum number of results to return. Default 25, maximum 100 (values over 100 return a 400 error). Example: 50.
offsetinteger
Index of the first result to return, for paging. Default 0. Example: 25 returns the second page when limit is 25.
klipfolio_group_getGet one user group by ID.Read-only
Get Group
Get one user group by ID. Returns its id, external_id, company, name, description and member count; with full=true also the members' IDs and names. Use klipfolio_group_get when you know the group ID. Use klipfolio_groups_list to find it.
Inputs
group_idstringrequired
ID of the group. Get it from the id field of klipfolio_groups_list. Example: "42c1accfbcfd54d44029ee5199805a9b".
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
fullboolean
Set to true to include associations in the response (members). Default false.
klipfolio_group_users_listList the users who belong to a group.Read-only
List Group Users
List the users who belong to a group. Returns each member's id, first and last name, and email. Use klipfolio_group_users_list to see who a group share reaches. Use klipfolio_users_list for all users.
Inputs
group_idstringrequired
ID of the group. Get it from the id field of klipfolio_groups_list. Example: "42c1accfbcfd54d44029ee5199805a9b".
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
klipfolio_groups_listList the user groups in the company or a client account.Read-only
List Groups
List the user groups in the company or a client account. Returns each group's id, name and description. Use klipfolio_groups_list to find group IDs for sharing. Use klipfolio_group_users_list for a group's members.
Inputs
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
limitinteger
Maximum number of results to return. Default 25, maximum 100 (values over 100 return a 400 error). Example: 50.
offsetinteger
Index of the first result to return, for paging. Default 0. Example: 25 returns the second page when limit is 25.
klipfolio_klip_annotation_getGet one annotation on a Klip.Read-only
Get Klip Annotation
Get one annotation on a Klip. Returns the annotation's id, body text, author id and name, and creation date. Use klipfolio_klip_annotation_get when you know the annotation ID. Use klipfolio_klip_annotations_list to find it.
Inputs
annotation_idstringrequired
ID of the annotation. Get it from the id field of klipfolio_klip_annotations_list. Example: "12345eba2f065109fb88be86b2f9279e".
klip_idstringrequired
ID of the Klip. Get it from the id field of klipfolio_klips_list. Example: "0123456789abcdef0123456789abcdef".
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
klipfolio_klip_annotations_listList the annotations (comments) on a Klip, optionally within a date range.Read-only
List Klip Annotations
List the annotations (comments) on a Klip, optionally within a date range. Returns each annotation's id, body text, author id and name, and creation date. Use klipfolio_klip_annotations_list to read a Klip's comments. Use klipfolio_klip_annotation_get for a single annotation.
Inputs
klip_idstringrequired
ID of the Klip. Get it from the id field of klipfolio_klips_list. Example: "0123456789abcdef0123456789abcdef".
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
end_dateinteger
Only return annotations created at or before this time, as Unix time in seconds. Leave empty for no upper bound (up to now). Example: 1781733386.
start_dateinteger
Only return annotations created at or after this time, as Unix time in seconds. Leave empty for no lower bound. Example: 1717200000.
klipfolio_klip_getGet one Klip by ID.Read-only
Get Klip
Get one Klip by ID. Returns its id, name, description, company, creator and created/updated dates; with full=true also group and user share rights, data sources and datasets. Use klipfolio_klip_get when you know the Klip ID. Use klipfolio_klips_list to find it, and klipfolio_klip_schema_get for the Klip's visual definition.
Inputs
klip_idstringrequired
ID of the Klip. Get it from the id field of klipfolio_klips_list. Example: "0123456789abcdef0123456789abcdef".
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
fullboolean
Set to true to include associations in the response (share rights, data sources, datasets). Default false.
klipfolio_klip_schema_getGet the schema (visual definition) of a Klip.Read-only
Get Klip Schema
Get the schema (visual definition) of a Klip. Returns the schema object: title, components with their formulas and formatting, layout config and the data sources the Klip uses. Use klipfolio_klip_schema_get before klipfolio_klip_schema_update, to edit the current schema rather than replace it blind.
Inputs
klip_idstringrequired
ID of the Klip. Get it from the id field of klipfolio_klips_list. Example: "0123456789abcdef0123456789abcdef".
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
klipfolio_klip_share_rights_getList the groups a Klip is shared with.Read-only
Get Klip Share Rights
List the groups a Klip is shared with. Returns share_rights entries with group_id, group_name and can_edit. Use klipfolio_klip_share_rights_get to audit access. Use klipfolio_klip_share_rights_update to grant or change it.
Inputs
klip_idstringrequired
ID of the Klip. Get it from the id field of klipfolio_klips_list. Example: "0123456789abcdef0123456789abcdef".
klipfolio_klips_listList the Klips (dashboard widgets) the user can access, optionally only those using one data source.Read-only
List Klips
List the Klips (dashboard widgets) the user can access, optionally only those using one data source. Returns each Klip's id, name and description, 25 per page by default. Use klipfolio_klips_list to browse or find Klip IDs. Use klipfolio_klip_get for one Klip's details and share rights.
Inputs
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
datasource_idstring
Only return Klips that use this data source. Get data source IDs from klipfolio_datasources_list. Example: "c98bad42a8c8a63e0b5e6c0f7aca9898".
limitinteger
Maximum number of results to return. Default 25, maximum 100 (values over 100 return a 400 error). Example: 50.
offsetinteger
Index of the first result to return, for paging. Default 0. Example: 25 returns the second page when limit is 25.
klipfolio_profile_getGet the account profile of the user who owns the API key.Read-only
Get Profile
Get the account profile of the user who owns the API key. Returns the user's id, name, email, company id and name, creation and last-login dates; with full=true also their dashboard instances, groups and permissions. Use klipfolio_profile_get to check which user and company the connection acts as. Use klipfolio_user_get for any other user.
Inputs
fullboolean
Set to true to include associations in the response (tab instances, dashboard properties, permissions). Default false.
klipfolio_published_link_getGet one published link by ID.Read-only
Get Published Link
Get one published link by ID. Returns its id, name, dashboard_url, visibility, creator, created and last-accessed dates. Use klipfolio_published_link_get when you know the link ID. Use klipfolio_published_links_list to list a dashboard's links.
Inputs
published_link_idstringrequired
ID of the published link. Get it from the id field of klipfolio_published_links_list. Example: "d2e5cdcf7f1d6e6e764e3b24e9edd762".
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
klipfolio_published_links_listList the published links (shareable public URLs) of one dashboard.Read-only
List Published Links
List the published links (shareable public URLs) of one dashboard. Returns each link's id, name, dashboard_url, visibility, creator, created and last-accessed dates. Use klipfolio_published_links_list to find a dashboard's links. Use klipfolio_published_link_get when you know the link ID.
Inputs
dashboard_idstringrequired
ID of the dashboard whose published links to list. Get it from klipfolio_dashboards_list. Example: "a30969fdee0cad2c3ee0e3587b40df32".
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
klipfolio_user_dashboards_listList the dashboards (tab instances) in a user's Klipfolio view.Read-only
List User Dashboards
List the dashboards (tab instances) in a user's Klipfolio view. Returns each tab instance's id, the source tab_id, name and context. Use klipfolio_user_dashboards_list to see which dashboards a user has open. Use klipfolio_user_dashboards_add to add more.
Inputs
user_idstringrequired
ID of the user. Get it from the id field of klipfolio_users_list. Example: "ab05f4a011e6a93fb307f4e3e970c3c0".
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
klipfolio_user_getGet one user by ID.Read-only
Get User
Get one user by ID. Returns the user's id, name, email, company, last login and creation dates and lock-out status; with full=true also their dashboard instances, groups, roles and properties. Use klipfolio_user_get when you know the user ID. Use klipfolio_users_list to find it, or klipfolio_profile_get for the API key's own user.
Inputs
user_idstringrequired
ID of the user. Get it from the id field of klipfolio_users_list. Example: "ab05f4a011e6a93fb307f4e3e970c3c0".
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
fullboolean
Set to true to include associations in the response (tab_instances, groups, roles, properties). Default false.
klipfolio_users_listList the users in the company or a client account, optionally finding one by email or external ID.Read-only
List Users
List the users in the company or a client account, optionally finding one by email or external ID. Returns each user's id, first and last name, email and last login date; optionally also their roles and groups. Use klipfolio_users_list to find user IDs. Use klipfolio_user_get for one user's dashboards, groups and roles.
Inputs
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
emailstring
Only return the user with this email address. Example: "jdoe@example.com".
external_idstring
Only return users with this external ID. Example: "emp-1042".
fullboolean
Set to true to include associations in the response (tab_instances, properties; only applies together with external_id). Default false.
include_groupsboolean
Set to true to include each user's groups. Default false.
include_rolesboolean
Set to true to include each user's roles. Default false.
limitinteger
Maximum number of results to return. Default 25, maximum 100 (values over 100 return a 400 error). Example: 50.
offsetinteger
Index of the first result to return, for paging. Default 0. Example: 25 returns the second page when limit is 25.
klipfolio_dashboard_createCreate an empty dashboard (tab) with a name and description.Write
Create Dashboard
Create an empty dashboard (tab) with a name and description. Returns the new dashboard's location (/tabs/<id>) in meta.location. Use klipfolio_dashboard_create to start a dashboard. Then use klipfolio_dashboard_klips_add to place Klips on it.
Inputs
descriptionstringrequired
Description of the dashboard. Example: "Weekly sales performance overview".
namestringrequired
Name of the dashboard. Example: "Sales KPIs".
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
klipfolio_dashboard_klips_addPlace one or more library Klips on a dashboard (tab), each as a new Klip instance.Write
Add Klips to Dashboard
Place one or more library Klips on a dashboard (tab), each as a new Klip instance. Returns the created klip_instances with their id, klip_id and name. Use klipfolio_dashboard_klips_add with Klip IDs from klipfolio_klips_list, not instance IDs. Use klipfolio_dashboard_layout_update to fine-tune positions afterwards.
- Idempotent
Inputs
dashboard_idstringrequired
ID of the dashboard (called a tab in the Klipfolio API). Get it from the id field of klipfolio_dashboards_list. Example: "fedcba9876543210fedcba9876543210".
klipsarrayrequired
Klips to add. Each entry needs the library klip_id (from klipfolio_klips_list) and can set region (column/region index, default 1) and position (order within the region, default 0). Example: [{"klip_id": "d012d123b56123d1234ef12c8f12c123", "region": 0, "position": 1}].
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
klipfolio_dashboard_layout_updateReplace the layout of a dashboard (tab): the layout type and the position of every Klip.Write
Update Dashboard Layout
Replace the layout of a dashboard (tab): the layout type and the position of every Klip. Returns meta.success on success. Use klipfolio_dashboard_layout_update to rearrange Klips. Klips missing from state are removed from the dashboard. Run klipfolio_dashboard_layout_get first and edit its result.
- Idempotent
Inputs
dashboard_idstringrequired
ID of the dashboard (called a tab in the Klipfolio API). Get it from the id field of klipfolio_dashboards_list. Example: "fedcba9876543210fedcba9876543210".
stateobjectrequired
Position of every Klip on the dashboard, in the same shape klipfolio_dashboard_layout_get returns for this layout type. Include every Klip instance, or the missing ones are removed. Example for a region layout: {"04462abd3a38372173645f3b50128596": {"region": "region-1", "idx": 1}}.
typestringrequired
Layout type, which sets the size and number of Klip columns. Use the type returned by klipfolio_dashboard_layout_get, for example "grid" or "100".
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
klipfolio_dashboard_share_rights_updateShare a dashboard (tab) with groups or users, or change their edit rights; new entries are added and existing ones updated.Write
Share Dashboard
Share a dashboard (tab) with groups or users, or change their edit rights; new entries are added and existing ones updated. Returns meta.success on success. Use klipfolio_dashboard_share_rights_update to grant access. Use klipfolio_dashboard_share_right_delete to revoke a group's access. Provide groups, users or both.
- Idempotent
Inputs
dashboard_idstringrequired
ID of the dashboard (called a tab in the Klipfolio API). Get it from the id field of klipfolio_dashboards_list. Example: "fedcba9876543210fedcba9876543210".
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
groupsarray
Groups to share with. Each entry has the group's ID (from klipfolio_groups_list) and can_edit, which is true to let the group edit or false for view-only access. Groups not yet shared get a new share right; existing ones are updated. Example: [{"group_id": "a9dff9e0b37ecd0fff24cba32ab88223", "can_edit": false}].
usersarray
Individual users to share with. Each entry has the user's ID (from klipfolio_users_list) and can_edit, which is true to let the user edit or false for view-only access. Example: [{"user_id": "abcdef0123456789abcdef0123456789", "can_edit": true}].
klipfolio_dashboard_updateUpdate a dashboard's (tab's) name or description.Write
Update Dashboard
Update a dashboard's (tab's) name or description. Returns meta.success on success. Use klipfolio_dashboard_update for the name and description. Use klipfolio_dashboard_layout_update to rearrange Klips.
- Idempotent
Inputs
dashboard_idstringrequired
ID of the dashboard (called a tab in the Klipfolio API). Get it from the id field of klipfolio_dashboards_list. Example: "fedcba9876543210fedcba9876543210".
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
descriptionstring
Description of the dashboard. Example: "Quarterly sales performance overview".
namestring
Name of the dashboard. Example: "Sales KPIs (Q3)".
klipfolio_datasource_createCreate a data source that pulls data from a connector, such as a REST/URL endpoint, on a refresh schedule.Write
Create Data Source
Create a data source that pulls data from a connector, such as a REST/URL endpoint, on a refresh schedule. Returns the new data source's location (/datasources/<id>) and its instance location in meta. Use klipfolio_datasource_create to bring new data into Klipfolio. Use klipfolio_datasource_update to rename it or change its refresh interval later.
Inputs
connectorstringrequired
Connector that fetches the data. Use simple_rest for any REST/URL endpoint. Example: "simple_rest".one of boxcomscoredbdropboxfacebookftpgoogle_adwordsgoogle_analyticsgoogle_drivegoogle_spreadsheetshubspotiformbuildermarketoomnitureradian6salesforcesearchMetricsshopifysimple_restsurvey_monkeyversaturexeroxmla
descriptionstringrequired
Description of the data source. Example: "Daily visits pulled from the analytics API".
formatstringrequired
Format of the fetched data, such as json, xml or csv. Example: "json".
namestringrequired
Name of the data source. Example: "Web Analytics".
refresh_intervalintegerrequired
How often Klipfolio refreshes the data, in seconds. Example: 14400 (every 4 hours).
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
propertiesobject
Connector settings. They depend on the connector; for simple_rest they include the endpoint_url and method, and optionally parameters (a JSON string listing headers or query parameters). Example: {"endpoint_url": "https://api.example.com/v1/visits", "method": "get"}.
klipfolio_datasource_disableDisable a data source so it stops refreshing, without deleting it.Write
Disable Data Source
Disable a data source so it stops refreshing, without deleting it. Returns data.op_requested = "disable" and meta.success. Use klipfolio_datasource_disable to pause refreshes. Use klipfolio_datasource_enable to resume, or klipfolio_datasource_delete to remove it.
Inputs
datasource_idstringrequired
ID of the data source. Get it from the id field of klipfolio_datasources_list. Example: "c98bad42a8c8a63e0b5e6c0f7aca9898".
klipfolio_datasource_enableEnable a disabled data source so it refreshes on schedule again.Write
Enable Data Source
Enable a disabled data source so it refreshes on schedule again. Returns data.op_requested = "enable" and meta.success. Use klipfolio_datasource_enable to resume a data source. Use klipfolio_datasource_disable to pause it.
Inputs
datasource_idstringrequired
ID of the data source. Get it from the id field of klipfolio_datasources_list. Example: "c98bad42a8c8a63e0b5e6c0f7aca9898".
klipfolio_datasource_instance_refreshQueue one data source instance for a refresh; the refresh runs shortly after, not instantly.Write
Refresh Data Source Instance
Queue one data source instance for a refresh; the refresh runs shortly after, not instantly. Returns data.op_requested = "refresh" and meta.success. Use klipfolio_datasource_instance_refresh for one instance. Use klipfolio_datasources_refresh to refresh whole data sources, several at once.
Inputs
instance_idstringrequired
ID of the data source instance. A data source that is not dynamic has one instance with the same ID as the data source; dynamic data sources have several. Get it from the id field of klipfolio_datasource_instances_list. Example: "4928fb1d95bfb4e02012de483c1234a5".
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
klipfolio_datasource_properties_updateCreate or update connection properties of a data source, such as its endpoint URL; properties you name are set and others are left alone.Write
Update Data Source Properties
Create or update connection properties of a data source, such as its endpoint URL; properties you name are set and others are left alone. Returns meta.success on success. Use klipfolio_datasource_properties_update to change where or how data is fetched. Use klipfolio_datasource_update for name, description and refresh interval.
- Idempotent
Inputs
datasource_idstringrequired
ID of the data source. Get it from the id field of klipfolio_datasources_list. Example: "c98bad42a8c8a63e0b5e6c0f7aca9898".
propertiesobjectrequired
Properties to create or update, as key/value pairs. The keys depend on the connector; for simple_rest they include endpoint_url and method. Example: {"endpoint_url": "https://api.example.com/v2/visits"}.
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
klipfolio_datasource_share_rights_updateShare a data source with groups or users, or change their edit rights; new entries are added and existing ones updated.Write
Share Data Source
Share a data source with groups or users, or change their edit rights; new entries are added and existing ones updated. Returns meta.success on success. Use klipfolio_datasource_share_rights_update to grant access. Use klipfolio_datasource_share_right_delete to revoke it. Provide groups, users or both.
- Idempotent
Inputs
datasource_idstringrequired
ID of the data source. Get it from the id field of klipfolio_datasources_list. Example: "c98bad42a8c8a63e0b5e6c0f7aca9898".
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
groupsarray
Groups to share with. Each entry has the group's ID (from klipfolio_groups_list) and can_edit, which is true to let the group edit or false for view-only access. Groups not yet shared get a new share right; existing ones are updated. Example: [{"group_id": "a9dff9e0b37ecd0fff24cba32ab88223", "can_edit": false}].
usersarray
Individual users to share with. Each entry has the user's ID (from klipfolio_users_list) and can_edit, which is true to let the user edit or false for view-only access. Example: [{"user_id": "abcdef0123456789abcdef0123456789", "can_edit": true}].
klipfolio_datasource_updateUpdate a data source's name, description or refresh interval.Write
Update Data Source
Update a data source's name, description or refresh interval. Returns an empty data object and meta.success on success. Use klipfolio_datasource_update for these three fields. Use klipfolio_datasource_properties_update to change connection settings such as the endpoint URL.
- Idempotent
Inputs
datasource_idstringrequired
ID of the data source. Get it from the id field of klipfolio_datasources_list. Example: "c98bad42a8c8a63e0b5e6c0f7aca9898".
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
descriptionstring
Description of the data source. Example: "Daily visits pulled from the analytics API".
namestring
Name of the data source. Example: "Web Analytics (daily)".
refresh_intervalinteger
New refresh interval in seconds. Example: 3600 (hourly).
klipfolio_datasources_refreshQueue one or more data sources, with all their instances, for a refresh in one call.Write
Refresh Data Sources
Queue one or more data sources, with all their instances, for a refresh in one call. Returns counts of data sources and instances requested and queued, plus failed_results for IDs that could not be queued. Use klipfolio_datasources_refresh by data source ID. Use klipfolio_datasource_instance_refresh to refresh a single instance of a dynamic data source.
Inputs
datasourcesarrayrequired
IDs of the data sources to refresh (from klipfolio_datasources_list). Example: ["1a12bc34de56abc12de3ab4c45de12a3", "2a12bc34de12abc12de3ab3c45de32a1"].
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
klipfolio_klip_annotation_createAdd an annotation (comment) to a Klip, authored by the API key's user.Write
Create Klip Annotation
Add an annotation (comment) to a Klip, authored by the API key's user. Returns the new annotation's location (/klips/<id>/annotations/<annotation id>) in meta.location. Use klipfolio_klip_annotation_create to add a note. Use klipfolio_klip_annotation_update to edit an existing one.
Inputs
bodystringrequired
Text of the annotation. Example: "Order volume dipped because of the June outage."
klip_idstringrequired
ID of the Klip. Get it from the id field of klipfolio_klips_list. Example: "0123456789abcdef0123456789abcdef".
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
klipfolio_klip_annotation_updateReplace the text of an annotation on a Klip.Write
Update Klip Annotation
Replace the text of an annotation on a Klip. Returns an empty data object and meta.success on success. Use klipfolio_klip_annotation_update to edit an annotation. Use klipfolio_klip_annotation_create to add a new one.
- Idempotent
Inputs
annotation_idstringrequired
ID of the annotation. Get it from the id field of klipfolio_klip_annotations_list. Example: "12345eba2f065109fb88be86b2f9279e".
bodystringrequired
New text of the annotation. Example: "Updated: outage resolved on June 3."
klip_idstringrequired
ID of the Klip. Get it from the id field of klipfolio_klips_list. Example: "0123456789abcdef0123456789abcdef".
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
klipfolio_klip_createCreate a Klip with a name and description, using Klipfolio's simple default schema.Write
Create Klip
Create a Klip with a name and description, using Klipfolio's simple default schema. Returns the new Klip's location (/klips/<id>) in meta.location. Use klipfolio_klip_create to add a Klip to the library. Then use klipfolio_klip_schema_update to define its visual and klipfolio_dashboard_klips_add to place it on a dashboard.
Inputs
descriptionstringrequired
Description of the Klip. Example: "Monthly revenue split by sales region".
namestringrequired
Name of the Klip. Example: "Revenue by Region".
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
klipfolio_klip_schema_updateReplace the schema (visual definition) of a Klip with the schema object you provide.Write
Update Klip Schema
Replace the schema (visual definition) of a Klip with the schema object you provide. Returns an empty data object and meta.success on success. Use klipfolio_klip_schema_update to change what a Klip displays. Use klipfolio_klip_update for its name and description. Run klipfolio_klip_schema_get first and send back the edited schema.
- Idempotent
Inputs
klip_idstringrequired
ID of the Klip. Get it from the id field of klipfolio_klips_list. Example: "0123456789abcdef0123456789abcdef".
schemaobjectrequired
The complete Klip schema to save, sent as the request body. Start from the schema returned by klipfolio_klip_schema_get and edit it. It has a title, an id, a workspace object listing the data source IDs the Klip uses, and a components array that describes each visual element with its formulas and formatting. Example: {"title": "Default", "id": "0123456789abcdef0123456789abcdef", "workspace": {"datasources": []}, "components": [{"type": "simple_value", "displayName": "Value", "id": "8c79ad9b-4", "components": []}]}.
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
klipfolio_klip_share_rights_updateShare a Klip with groups, or change their edit rights; new groups get a share right and existing ones are updated.Write
Share Klip
Share a Klip with groups, or change their edit rights; new groups get a share right and existing ones are updated. Returns an empty data object and meta.success on success. Use klipfolio_klip_share_rights_update to grant group access to a Klip. Use klipfolio_klip_share_rights_get to see current access.
- Idempotent
Inputs
groupsarrayrequired
Groups to share with. Each entry has the group's ID (from klipfolio_groups_list) and can_edit, which is true to let the group edit or false for view-only access. Groups not yet shared get a new share right; existing ones are updated. Example: [{"group_id": "a9dff9e0b37ecd0fff24cba32ab88223", "can_edit": false}].
klip_idstringrequired
ID of the Klip. Get it from the id field of klipfolio_klips_list. Example: "0123456789abcdef0123456789abcdef".
klipfolio_klip_updateUpdate a Klip's name or description.Write
Update Klip
Update a Klip's name or description. Returns an empty data object and meta.success on success. Use klipfolio_klip_update for the Klip's name and description only. Use klipfolio_klip_schema_update to change what the Klip shows.
- Idempotent
Inputs
klip_idstringrequired
ID of the Klip. Get it from the id field of klipfolio_klips_list. Example: "0123456789abcdef0123456789abcdef".
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
descriptionstring
Description of the Klip. Example: "Monthly revenue split by sales region".
namestring
Name of the Klip. Example: "Revenue by Region".
klipfolio_published_link_createPublish a dashboard as a shareable link, optionally password protected.Write
Create Published Link
Publish a dashboard as a shareable link, optionally password protected. Returns the new link's id, name, dashboard_url, visibility and creator. Use klipfolio_published_link_create to share a dashboard outside Klipfolio. Use klipfolio_published_link_update to change an existing link.
Inputs
dashboard_idstringrequired
ID of the dashboard to publish. Get it from klipfolio_dashboards_list. Example: "a30969fdee0cad2c3ee0e3587b40df32".
namestringrequired
Name of the published link. Example: "Board Review Q3".
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
is_publicboolean
Set to true to make the published link publicly searchable. Default false.
logostring
URL of a logo image to show on the published dashboard. Example: "https://example.com/logo.png".
passwordstring
Password viewers must enter to open the published link. Leave empty for no password. Example: "Q3-review-2024".
socialboolean
Set to true to show social sharing icons. Default false.
themestring
Color theme of the published dashboard: light or dark. Default light.one of lightdark
use_ip_rangesboolean
Set to true to restrict viewing to the account's allowed IP ranges. Default false.
wants_advertisingboolean
Klipfolio's wantsAdvertising flag for the published link. Default false.
klipfolio_published_link_updateUpdate a published link's name, password, visibility, theme, logo or other display options.Write
Update Published Link
Update a published link's name, password, visibility, theme, logo or other display options. Returns the updated link's id, name, dashboard_url and visibility. Use klipfolio_published_link_update to change a link. Use klipfolio_published_link_delete to revoke it.
- Idempotent
Inputs
published_link_idstringrequired
ID of the published link. Get it from the id field of klipfolio_published_links_list. Example: "d2e5cdcf7f1d6e6e764e3b24e9edd762".
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
is_publicboolean
Set to true to make the published link publicly searchable. Default false.
logostring
URL of a logo image to show on the published dashboard. Example: "https://example.com/logo.png".
namestring
Name of the published link. Example: "Board Review Q3 (final)".
passwordstring
Password viewers must enter to open the published link. Leave empty for no password. Example: "Q3-review-2024".
socialboolean
Set to true to show social sharing icons. Default false.
themestring
Color theme of the published dashboard: light or dark. Default light.one of lightdark
use_ip_rangesboolean
Set to true to restrict viewing to the account's allowed IP ranges. Default false.
wants_advertisingboolean
Klipfolio's wantsAdvertising flag for the published link. Default false.
klipfolio_user_dashboards_addAdd one or more dashboards to a user's Klipfolio view.Write
Add Dashboards to User
Add one or more dashboards to a user's Klipfolio view. Returns the created tab_instances with their id, tab_id and name. Use klipfolio_user_dashboards_add with dashboard IDs from klipfolio_dashboards_list, not tab instance IDs.
- Idempotent
Inputs
tab_idsarrayrequired
IDs of the dashboards (tabs) to add, from klipfolio_dashboards_list. Example: ["ab12a34580678e912d9c365e12b1bc00"].
user_idstringrequired
ID of the user. Get it from the id field of klipfolio_users_list. Example: "ab05f4a011e6a93fb307f4e3e970c3c0".
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
klipfolio_dashboard_deletePermanently delete a dashboard (tab).Destructive
Delete Dashboard
Permanently delete a dashboard (tab). Returns meta.success on success. Use klipfolio_dashboard_delete to remove the whole dashboard. Use klipfolio_dashboard_klip_instance_remove to remove a single Klip from it.
- Idempotent
Inputs
dashboard_idstringrequired
ID of the dashboard (called a tab in the Klipfolio API). Get it from the id field of klipfolio_dashboards_list. Example: "fedcba9876543210fedcba9876543210".
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
klipfolio_dashboard_klip_instance_removeRemove one Klip instance from a dashboard (tab); the Klip stays in the library.Destructive
Remove Klip from Dashboard
Remove one Klip instance from a dashboard (tab); the Klip stays in the library. Returns an empty data object and meta.success on success. Use klipfolio_dashboard_klip_instance_remove with an instance ID from klipfolio_dashboard_klip_instances_list. Use klipfolio_klip_delete to delete the Klip itself.
- Idempotent
Inputs
dashboard_idstringrequired
ID of the dashboard (called a tab in the Klipfolio API). Get it from the id field of klipfolio_dashboards_list. Example: "fedcba9876543210fedcba9876543210".
klip_instance_idstringrequired
ID of the Klip instance on this dashboard (not the library Klip ID). Get it from the id field of klipfolio_dashboard_klip_instances_list. Example: "04462abd3a38372173645f3b50128596".
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
klipfolio_dashboard_share_right_deleteRevoke a group's access to a dashboard (tab).Destructive
Unshare Dashboard from Group
Revoke a group's access to a dashboard (tab). Returns meta.success on success. Use klipfolio_dashboard_share_right_delete to remove a group's share right. Use klipfolio_dashboard_share_rights_update to change it to view-only instead.
- Idempotent
Inputs
dashboard_idstringrequired
ID of the dashboard (called a tab in the Klipfolio API). Get it from the id field of klipfolio_dashboards_list. Example: "fedcba9876543210fedcba9876543210".
group_idstringrequired
ID of the group. Get it from the id field of klipfolio_groups_list. Example: "42c1accfbcfd54d44029ee5199805a9b".
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
klipfolio_datasource_deletePermanently delete a data source.Destructive
Delete Data Source
Permanently delete a data source. Returns an empty data object and meta.success on success. Use klipfolio_datasource_delete to remove the data source; Klips that use it lose their data. Use klipfolio_datasource_disable to stop refreshes without deleting.
- Idempotent
Inputs
datasource_idstringrequired
ID of the data source. Get it from the id field of klipfolio_datasources_list. Example: "c98bad42a8c8a63e0b5e6c0f7aca9898".
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
klipfolio_datasource_share_right_deleteRevoke a group's or a user's access to a data source.Destructive
Unshare Data Source
Revoke a group's or a user's access to a data source. Returns an empty data object and meta.success on success. Use klipfolio_datasource_share_right_delete with a group ID, or a user ID plus type=user. Use klipfolio_datasource_share_rights_update to change access instead.
- Idempotent
Inputs
datasource_idstringrequired
ID of the data source. Get it from the id field of klipfolio_datasources_list. Example: "c98bad42a8c8a63e0b5e6c0f7aca9898".
principal_idstringrequired
ID of the group (from klipfolio_groups_list) or user (from klipfolio_users_list) whose access to revoke. When it is a user ID, also set type to "user". Example: "fedcba9876543210fedcba9876543210".
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
typestring
Set to "user" when principal_id is a user ID. Leave empty when it is a group ID.one of user
klipfolio_klip_annotation_deleteDelete an annotation from a Klip.Destructive
Delete Klip Annotation
Delete an annotation from a Klip. Returns an empty data object and meta.success on success. Use klipfolio_klip_annotation_delete to remove one annotation; the Klip itself is unchanged.
- Idempotent
Inputs
annotation_idstringrequired
ID of the annotation. Get it from the id field of klipfolio_klip_annotations_list. Example: "12345eba2f065109fb88be86b2f9279e".
klip_idstringrequired
ID of the Klip. Get it from the id field of klipfolio_klips_list. Example: "0123456789abcdef0123456789abcdef".
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
klipfolio_klip_deletePermanently delete a Klip from the library.Destructive
Delete Klip
Permanently delete a Klip from the library. Returns an empty data object and meta.success on success. Use klipfolio_klip_delete to remove the Klip everywhere. Use klipfolio_dashboard_klip_instance_remove to take it off one dashboard only.
- Idempotent
Inputs
klip_idstringrequired
ID of the Klip. Get it from the id field of klipfolio_klips_list. Example: "0123456789abcdef0123456789abcdef".
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".
klipfolio_published_link_deletePermanently delete a published link; its URL stops working.Destructive
Delete Published Link
Permanently delete a published link; its URL stops working. Returns an empty data object and meta.success on success. Use klipfolio_published_link_delete to revoke public access. The dashboard itself is unchanged.
- Idempotent
Inputs
published_link_idstringrequired
ID of the published link. Get it from the id field of klipfolio_published_links_list. Example: "d2e5cdcf7f1d6e6e764e3b24e9edd762".
client_idstring
ID of a client account to act in instead of your own company account (partner accounts that manage clients only). Leave empty to work in your own account. Get client IDs from klipfolio_clients_list. Example: "0123456789abcdef0123456789abcdef".

Setup

Install the SDK

Set your credentials

Create the Klipfolio connection

Authorize a user and make your first call

Tools

Call it

Returns

Get Client

Inputs

List Clients

Inputs

Get Dashboard

Inputs

List Dashboard Klips

Inputs

Get Dashboard Layout

Inputs

Get Dashboard Share Rights

Inputs

List Dashboards

Inputs

Get Data Source

Inputs

Get Data Source Instance Data

Inputs

Get Data Source Instance

Inputs

List Data Source Instances

Inputs

Get Data Source Properties

Inputs

Get Data Source Share Rights

Inputs

List Data Sources

Inputs

Get Group

Inputs

List Group Users

Inputs

List Groups

Inputs

Get Klip Annotation

Inputs

List Klip Annotations

Inputs

Get Klip

Inputs

Get Klip Schema

Inputs

Get Klip Share Rights

Inputs

List Klips

Inputs

Get Profile

Inputs

Get Published Link

Inputs

List Published Links

Inputs

List User Dashboards

Inputs

Get User

Inputs

List Users

Inputs

Create Dashboard

Inputs

Add Klips to Dashboard

Inputs

Update Dashboard Layout

Inputs

Share Dashboard

Inputs

Update Dashboard

Inputs

Create Data Source

Inputs

Disable Data Source

Inputs