Klipfolio

Delete a client. Requires the Klipfolio role permission `client.delete`. via DELETE /clients/{client_id}

Delete a company property from a client's account. Requires the Klipfolio role permission `client.edit`. via DELETE /clients/{client_id}/properties

Delete a client share right for a group. via DELETE /clients/{client_id}/share-rights/{group_id}

Deletes published link. Requires the Klipfolio role permission `tab.publish`. via DELETE /dashboard-published-links/{published_link_id}

Delete instances related to a specific data source. Requires the Klipfolio role permission `datasource.delete`. via DELETE /datasource-instances

Delete a specified data source instance. Requires the Klipfolio role permission `dashboard.library`. via DELETE /datasource-instances/{instance_id}/properties

Delete the data source associated with a specific data source ID. Requires the Klipfolio role permission `datasource.delete`. via DELETE /datasources/{datasource_id}

Delete a data source property. via DELETE /datasources/{datasource_id}/properties

Delete a data source share right for a group. via DELETE /datasources/{datasource_id}/share-rights/{group_id}

Delete a group in the company or client account. Requires the Klipfolio role permission `user.manage`. via DELETE /groups/{group_id}

Delete the specified dashboard (tab) from the group. Requires the Klipfolio role permission `user.manage`. via DELETE /groups/{group_id}/default-tabs/{default_tab_id}

Delete a user from a group. Requires the Klipfolio role permission `user.manage`. via DELETE /groups/{group_id}/users/{user_id}

Delete a specified Klip in the company or client account. Requires the Klipfolio role permission `klip.delete`. via DELETE /klips/{klip_id}

Remove an annotation from a specified Klip in the company or client account. Requires the Klipfolio role permission `dashboard.annotation.edit`. via DELETE /klips/{klip_id}/annotations/{annotation_id}

Delete a group’s share rights for the specified Klip. Requires the Klipfolio role permission `klip.share`. via DELETE /klips/{klip_id}/share-rights

Delete the specific role in the company or client account. Requires the Klipfolio role permission `user.manage`. via DELETE /roles/{role_id}

Delete a specific role permission in the company or client account. Requires the Klipfolio role permission `user.manage`. via DELETE /roles/{role_id}/permissions

Delete the specific user from the role in the company or client account. Requires the Klipfolio role permission `user.manage`. via DELETE /roles/{role_id}/users/{user_id}

Delete tab from the company or client account. Requires the Klipfolio role permission `tab.delete`. via DELETE /tabs/{tab_id}

Delete a Klip that is on a tab in the company or client account. Requires the Klipfolio role permission `dashboard.tab`. via DELETE /tabs/{tab_id}/klip-instances

Revoke access to a group tab in the company or client account. Requires the Klipfolio role permission `tab.share`. via DELETE /tabs/{tab_id}/share-rights/{group_id}

Delete the specified user in the company or client account. Requires the Klipfolio role permission `user.manage`. via DELETE /users/{user_id}

Delete a specified user from specified groups in the company or client account. Requires the Klipfolio role permission `user.manage`. via DELETE /users/{user_id}/groups/{group_id}

Delete properties associated with a user in your company or client account. Deleting a user property will delete the property from all users in your account. Requires the Klipfolio role permission `user.manage`. via DELETE /users/{user_id}/properties

Delete the user from a specified role in your company or client account. Requires the Klipfolio role permission `user.manage`. via DELETE /users/{user_id}/roles/{role_id}

Delete a user’s tab instance in your company or client account. Requires the Klipfolio role permission `user.manage`. via DELETE /users/{user_id}/tab-instances/{tab_instance_id}

Collects a list of all the clients associated with the requesting account. Users with admin role privileges have access to all clients. Requires the Klipfolio role permission `client.access`. via GET /clients

Get the details for the specified client. Requires the Klipfolio role permission `client.access`. via GET /clients/{client_id}

Update the status of the specified feature. Users with admin role privileges have access to all clients. Requires the Klipfolio role permission `client.edit`. via GET /clients/{client_id}/features

Retrieve a list of the client's company properties. Requires the Klipfolio role permission `client.access`. via GET /clients/{client_id}/properties

Lists all resources (dashboards, API resources, private links) allocated to a specified client. Users with admin role privileges have access to all clients. Requires the Klipfolio role permission `client.access`. via GET /clients/{client_id}/resources

Retrieve a list of settings for a specified client. Requires the Klipfolio role permission `client.access`. via GET /clients/{client_id}/settings

Get a list of the specified client’s share rights. Requires the Klipfolio role permission `client.access`. via GET /clients/{client_id}/share-rights

Returns published link details for a single published link or all published links for a specified dashboard. Requires the Klipfolio role permission `tab.publish`. via GET /dashboard-published-links

Get a list of all the datasource-instances to which the user has access. Note that the "id" returned is the id of the data source instance - use this id to query for a specific instance. The id of the related data source is "datasource_id". Requires the Klipfolio role permission `dashboard.library`. via GET /datasource-instances

Get the details for a specific data source instance id. Note that the "id" returned is the id of the data source instance. The id of the related data source is "datasource_id". *Note: dates are returned in UTC time.*. Requires the Klipfolio role permission `dashboard.library`. via GET /datasource-instances/{instance_id}

Get the details for the specific data source ID. Requires the Klipfolio role permission `dashboard.library`. via GET /datasource-instances/{instance_id}/data

Get the properties for the specific. Requires the Klipfolio role permission `dashboard.library`. via GET /datasource-instances/{instance_id}/properties

Get a list of all the data sources to which the user has access. Requires the Klipfolio role permission `dashboard.library`. via GET /datasources

Get the details for the specific data source id. Requires the Klipfolio role permission `dashboard.library`. via GET /datasources/{datasource_id}

Retrieve a list of a data source's properties. via GET /datasources/{datasource_id}/properties

Retrieve a list of a data source's share rights. via GET /datasources/{datasource_id}/share-rights

Get the details for all groups in the company or client account. via GET /groups

Get the details for the specific group in the company or client account. Requires the Klipfolio role permission `user.manage`. via GET /groups/{group_id}

Retrieve a list of default tabs (now called dashboards) for a specific group. Requires the Klipfolio role permission `user.manage`. via GET /groups/{group_id}/default-tabs

Retrieve the details for a specific group and specific dashboard (tab). Requires the Klipfolio role permission `user.manage`. via GET /groups/{group_id}/default-tabs/{default_tab_id}

Get the details for all users in a group. Requires the Klipfolio role permission `dashboard.library`. via GET /groups/{group_id}/users

Get a list of all the Klips the user can access in the company or client account. Requires the Klipfolio role permission `dashboard.library`. via GET /klips

Get the details for the specified Klip in the company or client account. Requires the Klipfolio role permission `dashboard.library`. via GET /klips/{klip_id}

Retrieve a list of annotations for a specified Klip in the company or client account. Requires the Klipfolio role permission `dashboard.annotation.view`. via GET /klips/{klip_id}/annotations

Retrieve the details of an annotation for a specified Klip in the company or client account. Requires the Klipfolio role permission `dashboard.annotation.view`. via GET /klips/{klip_id}/annotations/{annotation_id}

Returns a list of Klip instances for a specified Klip in the company or client account. Requires the Klipfolio role permission `client.access`, `dashboard.library`. via GET /klips/{klip_id}/client-instances

Get the schema for the specified klip in the company or client account. Requires the Klipfolio role permission `klip.edit`. via GET /klips/{klip_id}/schema

Get a list of share rights for the specified Klip. Requires the Klipfolio role permission `dashboard.library`. via GET /klips/{klip_id}/share-rights

Retrieve information about the authenticated user account. When the full parameter is set to true, the information includes associations (tab instances, dashboard properties, permissions for the authenticated user account). via GET /profile

Retrieve all of the roles in the company or client account. Requires the Klipfolio role permission `user.manage`. via GET /roles

Get the details for the specific role id in the company or client account. Requires the Klipfolio role permission `user.manage`. via GET /roles/{role_id}

Get a list of all the role’s permissions in the company or client account. Requires the Klipfolio role permission `user.manage`. via GET /roles/{role_id}/permissions

Get a list of all the users associated with this role in the company or client account. Requires the Klipfolio role permission `user.manage`. via GET /roles/{role_id}/users

Get a list of all the tabs in the company or client account. Requires the Klipfolio role permission `dashboard.library`. via GET /tabs

Get the details for the specific tab in the company or client account. Requires the Klipfolio role permission `dashboard.library`. via GET /tabs/{tab_id}

Get a list of the Klip instances associated with the tab in the company or client account. Requires the Klipfolio role permission `dashboard.tab`. via GET /tabs/{tab_id}/klip-instances

Get the layout of a tab in the company or client account. Requires the Klipfolio role permission `dashboard.share`. via GET /tabs/{tab_id}/layout

Get a list of the tab’s share rights in the company or client account. Requires the Klipfolio role permission `tab.share`. via GET /tabs/{tab_id}/share-rights

Get a list of all the users in the company or client account. via GET /users

Get details for the specified user in the company or client account. Requires the Klipfolio role permission `user.manage`. via GET /users/{user_id}

Retrieve the list of groups to which the specified user belongs in the company or client account. Requires the Klipfolio role permission `user.manage`. via GET /users/{user_id}/groups

Get a list of the user’s properties in your company or client account. Requires the Klipfolio role permission `user.manage`. via GET /users/{user_id}/properties

Get a list of the user’s roles in your company or client account. Requires the Klipfolio role permission `user.manage`. via GET /users/{user_id}/roles

Retrieve a list of the user’s tab instances in your company or client account. Requires the Klipfolio role permission `user.manage`. via GET /users/{user_id}/tab-instances

Create a client. Requires the Klipfolio role permission `client.build`. via POST /clients

Switch a client to direct billing. This cannot be undone. This command is only available to Partner accounts. Requires the Klipfolio role permission `client.access`. via POST /clients/{client_id}/@/enable_direct_billing

Extend a client’s trial period. Requires the Klipfolio role permission `client.access`. via POST /clients/{client_id}/@/extend_trial

Sets the value of one or more company properties. Requires the Klipfolio role permission `client.access`. via POST /clients/{client_id}/settings

Creates a new published link. Requires the Klipfolio role permission `tab.publish`. via POST /dashboard-published-links/{dashboard_id}

Create a new data source instance based on a data source (specified as “datasource_id” in the post data). Data source instance properties can optionally be specified in the post data. Requires the Klipfolio role permission `datasource.create`. via POST /datasource-instances

Refresh the specified data source instance. This refresh operation queues the data source for refresh, but it does not necessarily refresh it instantly. Requires the Klipfolio role permission `dashboard.library`. via POST /datasource-instances/{instance_id}/@/refresh

Create a data source. Data source properties can optionally be specified in the post data. Requires the Klipfolio role permission `datasource.create`. via POST /datasources

Delete instances related to a specified data source. Requires the Klipfolio role permission `datasource.delete`. via POST /datasources/{datasource_id}/@/delete_instances

Disable the specific datasource ID. Requires the Klipfolio role permission `datasource.edit`. via POST /datasources/{datasource_id}/@/disable

Enable the specific datasource id. Requires the Klipfolio role permission `datasource.edit`. via POST /datasources/{datasource_id}/@/enable

Import the data source into the client account specified in the post data by the client id. The location of the newly imported data source is returned on successful completion. Requires the Klipfolio role permission `datasource.import`. That permission is marked 'only available for partners', so this operation answers 403 on an ordinary account -- an account entitlement rather than a problem with the key. via POST /datasources/{datasource_id}/@/import

Queue multiple data sources for refresh in one API call. Requires the Klipfolio role permission `datasource.edit`. via POST /datasources/@/refresh

Create a new group in the company or client account. Requires the Klipfolio role permission `user.manage`. via POST /groups

Add an existing dashboard to a specified group. Requires the Klipfolio role permission `user.manage`. via POST /groups/{group_id}/default-tabs

Create a Klip; optionally include ‘client_id’ in the post data to create a Klip for a client. A schema may be specified by including ‘schema’ in the post data. If no schema is specified, the new Klip will have a simple default schema, which may be updated using the /klips/{id}/schema resource. Requires the Klipfolio role permission `klip.build`. via POST /klips

Create a new annotation for a specified Klip in the company or client account. Requires the Klipfolio role permission `dashboard.annotation.edit`. via POST /klips/{klip_id}/annotations

Import a Klip. Requires the Klipfolio role permission `klip.import`. That permission is marked 'only available for partners', so this operation answers 403 on an ordinary account -- an account entitlement rather than a problem with the key. via POST /klips/{klip_id}/@/import

Updates a specified client instance of a Klip schema by replacing it with the schema of the original Klip. Requires the Klipfolio role permission `account.api`, `klip.import`. That permission is marked 'only available for partners', so this operation answers 403 on an ordinary account -- an account entitlement rather than a problem with the key. via POST /klips/{klip_id}/@/update_from_parent

Create a new tab in the company or client account. Requires the Klipfolio role permission `tab.build`. via POST /tabs

Import the tab into the client account specified in the post data by the client id. All related Klips will also be imported along with the tab. The location of the newly imported tab is returned on success. Requires the Klipfolio role permission `tab.import`. That permission is marked 'only available for partners', so this operation answers 403 on an ordinary account -- an account entitlement rather than a problem with the key. via POST /tabs/{tab_id}/@/import

Create a new user, optionally for a client. user.manage. Requires the Klipfolio role permission `user.manage`. via POST /users

Resend the invitation email to a new user. Requires the Klipfolio role permission `user.manage`. via POST /users/{user_id}/@/resend-invite

Reset a user password. Requires the Klipfolio role permission `user.manage`. via POST /users/{user_id}/@/reset-password

Update the specified client. Requires the Klipfolio role permission `client.edit`. via PUT /clients/{client_id}

Add or update company properties in a client's account. Requires the Klipfolio role permission `client.edit`. via PUT /clients/{client_id}/properties

Update the specified client’s share rights. If the client is not already shared with a specified group, a new share right is created, otherwise the existing share right is updated. Requires the Klipfolio role permission `client.share`. via PUT /clients/{client_id}/share-rights

Updates the properties of a published link. Requires the Klipfolio role permission `tab.publish`. via PUT /dashboard-published-links/{published_link_id}

Update the specified data source instance with data. Works with files and with raw data. For web accessible data sources use POST /@/refresh to get new data. Requires the Klipfolio role permission `dashboard.library`. via PUT /datasource-instances/{instance_id}/data

Create or update properties for this data source instance. If the specified property does not already exist it is created, otherwise the existing property is updated. Requires the Klipfolio role permission `dashboard.library`. via PUT /datasource-instances/{instance_id}/properties

Update the specified data source. Requires the Klipfolio role permission `datasource.edit`. via PUT /datasources/{datasource_id}

Add or update a data source's properties. via PUT /datasources/{datasource_id}/properties

Add or update a data source's share rights. via PUT /datasources/{datasource_id}/share-rights

Update the specified group in the company or client account. Requires the Klipfolio role permission `user.manage`. via PUT /groups/{group_id}

Update an existing dashboard for a specified group. Requires the Klipfolio role permission `user.manage`. via PUT /groups/{group_id}/default-tabs/{default_tab_id}

Add the user to the group. Requires the Klipfolio role permission `dashboard.library`. via PUT /groups/{group_id}/users/{user_id}

Update the specified klip details in the company or client account. To update the klip schema, use the /klips/{id}/schema resource. Requires the Klipfolio role permission `klip.edit`. via PUT /klips/{klip_id}

Update an annotation for a specified Klip in the company or client account. Requires the Klipfolio role permission `dashboard.annotation.edit`. via PUT /klips/{klip_id}/annotations/{annotation_id}

Update the schema for the specified Klip in the company or client account. Requires the Klipfolio role permission `klip.edit`. via PUT /klips/{klip_id}/schema

Update the share rights for the specified Klip. If the Klip is not already shared with the specified group, a new share-right is created, otherwise the existing share-right is updated. Requires the Klipfolio role permission `klip.share`. via PUT /klips/{klip_id}/share-rights

Update the specified role in the company or client account. Permissions specified will replace existing permissions. Requires the Klipfolio role permission `user.manage`. via PUT /roles/{role_id}

Update the permissions associated with the role in the company or client account. Requires the Klipfolio role permission `user.manage`. via PUT /roles/{role_id}/permissions

Add a user to the role in the company or client account. Requires the Klipfolio role permission `user.manage`. via PUT /roles/{role_id}/users/{user_id}

Update the specified tab in the company or client account. Requires the Klipfolio role permission `tab.edit`. via PUT /tabs/{tab_id}

Add a Klip to a tab. The Klip id is used instead of the Klip instance id. Use in the company or client account. * Note:* If region and position are not included, they default to 1 and 0 respectively. Requires the Klipfolio role permission `dashboard.tab`. via PUT /tabs/{tab_id}/klip-instances

Update the layout of the tab. The layout “type” refers to the size and number of Klip columns on the tab. The layout “state” is a JSON object representing the position of each Klip on the tab. Works in the company or client account. Note: all details must be provided or Klips will be removed from dashboard when the command is run. Requires the Klipfolio role permission `dashboard.share`. via PUT /tabs/{tab_id}/layout

Update a tab's share rights in the company or client account. If the tab is not already shared with the specified group or user, a new share right is created, otherwise the existing right is updated. Requires the Klipfolio role permission `tab.share`. via PUT /tabs/{tab_id}/share-rights

Update the specified user in the company or client account. Requires the Klipfolio role permission `user.manage`. via PUT /users/{user_id}

Add a specified user to one group at a time in the company or client account. Requires the Klipfolio role permission `user.manage`. via PUT /users/{user_id}/groups/{group_id}

Creates property base on name for all users. Update property for specific user. Use in your company or client account. Requires the Klipfolio role permission `user.manage`. via PUT /users/{user_id}/properties

Assign a user to a role in your company or client account. Requires the Klipfolio role permission `user.manage`. via PUT /users/{user_id}/roles/{role_id}

Add one or more tabs to a user’s dashboard in your company or client account. Use tab IDs not tab instance IDs. Requires the Klipfolio role permission `user.manage`. via PUT /users/{user_id}/tab-instances