Skip to main content
Klipfolio logo
  • Category: business intelligence
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 50
  • Triggers: 0
  • Slug: KLIPFOLIO
  • Version: 20261101_00

Tools

Slug: KLIPFOLIO_ASSIGN_USER_ROLETool to assign a role to a user in Klipfolio. Use when you need to grant role-based permissions to a specific user. Requires both user ID and role ID.

Input Parameters

string
required
The unique identifier of the user to assign the role to.
string
required
The unique identifier of the role to assign to the user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_CREATE_DATA_SOURCECreates a Klipfolio data source using a name, format, connector, endpoint URL and description, with optional refresh interval, method and additional properties.

Input Parameters

string
required
The name of the data source
string
required
The format of the data source (e.g., csv, json, xml)
string
The HTTP method to use for the data source
string
required
The connector type (e.g., simple_rest, google_analytics, etc.)
string
required
A description of the data source
string
required
The URL endpoint for the data source
integer
The refresh interval in seconds
object
Additional properties specific to the connector type

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_CREATE_DATA_SOURCE_INSTANCETool to create a new data source instance based on an existing data source in Klipfolio. Use when you need to instantiate a data source with specific properties or configuration. Requires datasource.create permission.

Input Parameters

boolean
If true, creates a data source instance that doesn’t refresh automatically. Useful when pushing data directly to the instance
object
Data source instance properties as key-value pairs. These properties are specific to the data source type and can include configuration settings
string
required
The unique identifier of the data source to create an instance from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_CREATE_GROUPTool to create a new group in Klipfolio. Use when you need to organize users into groups for managing permissions and access control.

Input Parameters

string
required
The name of the new group.
string
Optional client ID to associate the group with a specific client.
string
A brief description of the group.
string
Optional external identifier for the group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_CREATE_ROLETool to create a new role in Klipfolio with optional permissions. Use when you need to define a new role with specific access rights. Requires ‘user.manage’ permission.

Input Parameters

string
required
The name of the role to create.
string
A description of the role and its purpose.
array
List of permission strings to assign to the role (e.g., ‘klip.build’, ‘klip.edit’, ‘user.view’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_CREATE_TABThis tool creates a new tab (dashboard) in Klipfolio. A tab serves as a container for organizing and displaying Klips (data visualizations) in a meaningful way. The tool allows users to set up a new dashboard with specific properties and configurations.

Input Parameters

string
required
The name of the new dashboard/tab.
string
Optional client ID to associate the dashboard with a specific client.
string
required
A brief description of the dashboard/tab.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_CREATE_USERTool to create a new user in Klipfolio with optional roles and client association. Use when you need to add a new user account. Requires ‘user.manage’ permission.

Input Parameters

string
required
The email address of the user. Must be unique.
array
List of role IDs to assign to the user.
string
Optional password for the user. If not provided, a temporary password will be generated.
string
The client ID to associate the user with a specific client.
string
required
The last name of the user to create.
string
required
The first name of the user to create.
boolean
Whether to send a welcome email to the user. Defaults to false if not specified.
string
An external identifier for the user (for integration purposes).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_DELETE_DATA_SOURCEThis tool permanently removes a specified data source from the Klipfolio account. This operation is destructive and cannot be undone. The data source must not be currently in use, and proper permissions are required.

Input Parameters

string
required
The unique identifier of the data source to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_DELETE_DATA_SOURCE_INSTANCE_PROPERTYTool to delete a property from a data source instance in Klipfolio. Use when you need to remove custom properties or metadata from a specific data source instance.

Input Parameters

string
required
The unique identifier of the data source instance
string
required
The name of the property to delete from the data source instance

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_DELETE_DATA_SOURCE_PROPERTYTool to delete a property from a data source in Klipfolio. Use when you need to remove custom properties or metadata from a specific data source.

Input Parameters

string
required
The unique identifier of the data source
string
required
The name of the property to delete from the data source

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_DELETE_DATA_SOURCE_SHARE_RIGHTTool to delete a data source share right for a specific user or group. Use when you need to revoke access permissions from a data source.

Input Parameters

string
required
The unique identifier of the data source.
string ("user" | "group")
Type of entity for the share right.
string
required
The unique identifier of the user or group to remove share rights from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_DELETE_GROUPTool to permanently delete a specified group from the Klipfolio account. Use when you need to remove a user group. This operation is destructive and cannot be undone. Proper permissions are required.

Input Parameters

string
required
The unique identifier of the group to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_DELETE_ROLETool to delete a role from Klipfolio. Use when you need to permanently remove a role from the account. This operation is destructive and cannot be undone.

Input Parameters

string
required
The unique identifier of the role to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_DISABLE_DATA_SOURCETool to disable a data source in Klipfolio. Use when you need to temporarily stop a data source from refreshing without deleting it. The data source can be re-enabled later if needed.

Input Parameters

string
required
The unique identifier of the data source to disable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_ENABLE_DATA_SOURCETool to enable a disabled data source in Klipfolio. Use when you need to reactivate a data source that was previously disabled. Note: The data source must be in disabled state before it can be enabled, otherwise a 403 error will be returned.

Input Parameters

string
required
The unique identifier of the data source to enable. Note: the data source must be in disabled state before it can be enabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_GET_DASHBOARDRetrieves details for a specific Klipfolio dashboard, formerly called a tab, including its name, description, company and creation metadata.

Input Parameters

string
required
The unique identifier of the dashboard to retrieve.
boolean
Include associations in the listing (klip_instances, share_rights).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_GET_DATA_SOURCETool to retrieve detailed information about a specific data source in Klipfolio. Use when you need to get configuration details, refresh settings, or metadata for a data source.

Input Parameters

string
required
The unique identifier of the data source to retrieve details for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_GET_DATA_SOURCE_INSTANCE2Tool to retrieve detailed information about a specific data source instance in Klipfolio. Use when you need to fetch metadata and status for a data source instance.

Input Parameters

string
required
The unique identifier of the data source instance to retrieve details for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_GET_DATA_SOURCE_INSTANCE_DATATool to retrieve the actual data from a specific data source instance in Klipfolio. Use when you need to access the raw data stored in a data source instance.

Input Parameters

string
required
The unique identifier of the data source instance to retrieve data from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_GET_DATA_SOURCE_INSTANCE_PROPERTIESTool to retrieve configuration properties for a specific data source instance in Klipfolio. Use when you need to inspect how the API connects to a data source instance (endpoint URL, method, headers, etc.).

Input Parameters

string
required
The unique identifier of the data source instance to retrieve properties for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_GET_DATA_SOURCE_PROPERTIESTool to retrieve properties for a specific data source in Klipfolio by its ID. Use when you need to get configuration details of a data source such as endpoint URLs, authentication tokens, or custom properties.

Input Parameters

string
required
The unique identifier of the data source to retrieve properties for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_GET_DATA_SOURCE_SHARE_RIGHTSTool to retrieve sharing permissions for a specific data source in Klipfolio. Returns both group-level and user-level access rights, including edit permissions for each.

Input Parameters

string
required
The unique identifier of the data source to retrieve share rights for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_GET_GROUPTool to retrieve detailed information about a specific group in Klipfolio. Use when you need to get group properties such as name, description, member count, and optionally the list of members.

Input Parameters

string
required
Unique identifier of the group to retrieve.
boolean
Include associations in the listing (members). When true, the members array will be populated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_GET_GROUP_DEFAULT_TABSTool to retrieve the list of default tabs (dashboards) for a specific group. Use when you need to see which dashboards are set as defaults for a user group.

Input Parameters

string
required
The unique identifier of the group to retrieve default tabs for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_GET_GROUP_USERSRetrieve users belonging to a specific Klipfolio group. The request returns a page of results.

Input Parameters

string
required
Unique identifier of the group to retrieve users from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_GET_KLIPSList Klips accessible to the authenticated user, with optional pagination. Klips are visualization components that display data in formats such as charts, tables or metrics.

Input Parameters

integer
Maximum number of results to return
integer
Number of records to skip before starting to return data

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_GET_PROFILERetrieve the authenticated user’s Klipfolio profile and test API connectivity. Returned profile details include user ID, name and email, with company, roles, groups and account details when available.

Input Parameters

boolean
Include the user’s roles in the response
boolean
Include the user’s groups in the response

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_GET_ROLETool to retrieve detailed information about a specific role in Klipfolio. Use when you need to check role permissions, view role assignments, or understand role configuration.

Input Parameters

string
required
The unique identifier of the role to retrieve
boolean
Include additional details such as users, num_users, and permissions in the response

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_GET_ROLE_PERMISSIONSTool to retrieve the list of permissions assigned to a specific role in Klipfolio. Use when you need to view what permissions a role has, such as account.api, admin.client, client.access, dashboard permissions, datasource permissions, klip permissions, tab permissions, or user.manage.

Input Parameters

string
required
The unique identifier of the role to retrieve permissions for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_GET_ROLE_USERSTool to retrieve all users associated with a specific role in Klipfolio. Use when you need to see which users are assigned to a role. Requires user.manage permission.

Input Parameters

string
required
The unique identifier of the role to retrieve users for (32-character hexadecimal).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_GET_USERTool to retrieve detailed information about a specific user in Klipfolio. Use when you need to get user properties such as name, email, login history, group memberships, and role assignments.

Input Parameters

string
required
Unique identifier of the user to retrieve.
boolean
Include additional associations in the response (tab_instances, groups, roles, properties). When true, the response will include expanded user details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_GET_USER_GROUPSTool to retrieve all groups that a specific user belongs to in Klipfolio. Use when you need to check group membership for a user.

Input Parameters

string
required
Unique identifier of the user to retrieve groups for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_GET_USER_PROPERTIESTool to retrieve custom properties associated with a specific user in Klipfolio. Use when you need to access user-defined key-value pairs stored as user properties.

Input Parameters

string
required
The unique identifier of the user whose properties to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_GET_USER_ROLESRetrieve the roles assigned to a specific user in Klipfolio, including role IDs, names, and descriptions.

Input Parameters

string
required
The unique identifier of the user whose roles to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_GET_USER_TAB_INSTANCESTool to retrieve all tab instances associated with a specific user. Use when you need to view dashboard copies assigned to a user’s account. Tab instances represent copies of tabs in a user’s account.

Input Parameters

string
required
The unique identifier of the user whose tab instances to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_LIST_DATA_SOURCE_INSTANCESLists a page of data source instances accessible to the authenticated user, with optional filtering by client or data source and pagination controls.

Input Parameters

integer
Maximum number of data source instances to return per page (default 25, max 100).
integer
Number of data source instances to skip for pagination.
string
Filter results to show only instances belonging to a specified client.
string
Filter results to show only instances of a particular data source (use the data source ID, not the instance ID).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_LIST_DATA_SOURCESList accessible Klipfolio data sources, with optional pagination and client filtering. Results include IDs, names, descriptions, refresh intervals, last refresh timestamps and dynamic status when available.

Input Parameters

integer
Maximum number of data sources to return
integer
Number of data sources to skip
string
ID of the client to retrieve data sources for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_LIST_GROUPSList Klipfolio groups with optional pagination and filtering by client or external ID. Results include group IDs, names and descriptions.

Input Parameters

boolean
When set to true, includes associated member data in the listing. Note: This parameter only functions when specifying an external_id
integer
Maximum number of groups to return per page (default 25, max 100).
integer
Number of groups to skip for pagination.
string
Filters results to show only groups belonging to a specific client
string
Filters results to display only groups with the specified external identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_LIST_ROLESList roles in the company or a specified client account. The result is the first page of roles, with up to 25 returned by default.

Input Parameters

string
Filter roles by a specific client ID. If not provided, returns all roles in the company.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_LIST_USERSList a page of users in the company or a specified client account. Search by email or external ID, or retrieve user details for access management.

Input Parameters

boolean
When true, includes additional user details in the response such as company, date_created, is_locked_out, and properties.
string
Filter users by email address. Returns users matching the specified email.
integer
Maximum number of users to return per page (default 25, max 100).
integer
Number of users to skip for pagination.
string
Filter users by a specific client ID. If not provided, returns all users in the company.
string
Filter users by external ID. Returns users with the specified external identifier.
boolean
When true, includes the list of role IDs assigned to each user in the response.
boolean
When true, includes the list of groups each user belongs to in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_REFRESH_DATA_SOURCE_INSTANCETool to manually refresh a data source instance in Klipfolio. Use when you need to update the data from its source immediately rather than waiting for the scheduled refresh interval.

Input Parameters

string
required
The unique identifier of the data source instance to refresh

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_REFRESH_MULTIPLE_DATA_SOURCESThis tool allows users to refresh multiple data sources in Klipfolio simultaneously. It queues the specified data sources for refresh, updating their data from their respective sources. At least one data source ID must be provided.

Input Parameters

array
required
List of data source IDs to refresh. At least one ID must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_RESEND_USER_INVITETool to resend a user invitation email in Klipfolio. Use when you need to resend an invitation to a user who has not yet accepted their account invite.

Input Parameters

string
required
The unique identifier of the user to resend the invitation email to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_RESET_USER_PASSWORDTool to reset a user’s password in Klipfolio. Use when you need to trigger a password reset for a specific user account. This will send a password reset link to the user.

Input Parameters

string
required
The unique identifier of the user whose password should be reset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_UPDATE_DATA_SOURCEReplaces data in a Klipfolio data source instance with supplied text or CSV data. The identifier addresses the instance; for a non-dynamic data source, its single instance has the same ID as the data source.

Input Parameters

string
required
The plain-text or CSV data to replace the existing data in the data source
string
The content type of the data being sent. Use ‘text/csv’ for CSV data or ‘text/plain’ for plain text.
string
required
The ID of the data source to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_UPDATE_DATA_SOURCE_INSTANCE_PROPERTIESTool to update custom properties on a Klipfolio data source instance. Use when you need to set or modify key-value property pairs on an existing data source instance.

Input Parameters

string
required
The unique identifier of the data source instance to update properties for
object
required
A dictionary of key-value pairs representing the properties to update on the data source instance. All values must be strings

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_UPDATE_DATA_SOURCE_METADATATool to update metadata (name, description, refresh_interval) of an existing data source. Use when you need to modify properties of a data source without changing its actual data.

Input Parameters

string
required
The unique identifier of the data source to update
string
The new name for the data source
string
The new description for the data source
integer ("0" | "60" | "300" | "900" | "1800" | "3600" | "7200" | "10800" | "14400" | "43200" | "86400")
The new refresh interval in seconds. Must be one of: 0, 60, 300, 900, 1800, 3600, 7200, 10800, 14400, 43200, 86400

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_UPDATE_DATA_SOURCE_PROPERTIESTool to update custom properties for a data source in Klipfolio. Use when you need to modify metadata or configuration properties associated with a specific data source.

Input Parameters

string
required
The unique identifier of the data source to update properties for
object
required
A dictionary of key-value pairs representing the properties to update for the data source. These are custom properties that can be used to store metadata or configuration for the data source. All values should be strings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_UPDATE_DATA_SOURCE_SHARE_RIGHTSTool to update data source share rights in Klipfolio. Use when you need to grant or modify access permissions for users or groups to a specific data source. This allows you to control who can view or edit a data source by specifying user IDs and group IDs with their respective permissions.

Input Parameters

string
required
The unique identifier of the data source to update share rights for
array
List of users to grant access to the data source. Each user can have edit or read-only permissions
array
List of groups to grant access to the data source. Each group can have edit or read-only permissions

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLIPFOLIO_UPDATE_USER_PROPERTIESTool to update custom properties for a user in Klipfolio. Use when you need to modify metadata or configuration properties associated with a specific user account.

Input Parameters

string
required
The unique identifier of the user to update properties for
object
required
A dictionary of key-value pairs representing the custom properties to update for the user. These are custom properties that can be used to store metadata or user-specific configuration. All values should be strings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not