Tools

List Applications

List all applications in a given workspace. Applications are the main building blocks in Appsmith, containing pages, datasources, queries, and JS objects.

Import Application

Import an Appsmith application into a workspace from a JSON definition. The JSON should be in the format produced by the export application tool. Datasource credentials must be reconfigured after import.

Trigger Workflow

Trigger an Appsmith workflow by sending a POST request to its webhook URL. The workflow receives the provided JSON payload as input parameters and may return a response. Requires Business or Enterprise edition.

Query Audit Logs

Query audit logs from an Appsmith instance. Audit logs record notable events including application CRUD, user login/signup, query executions, datasource changes, and configuration updates. **Requires Business or Enterprise edition.**

List Workspaces

List all workspaces accessible to the authenticated user. Workspaces are the organizational unit in Appsmith that group applications, datasources, and users together.

Get Instance Info

Retrieve configuration and feature information about an Appsmith instance, including feature flags, license plan, and available authentication providers. This unauthenticated endpoint is useful for monitoring instance configuration.

Manage Workspace

Create, update, or delete an Appsmith workspace. Can also retrieve workspace details and members. To create a workspace, provide a name. To update or delete, provide the workspace ID.

Check Instance Health

Check whether an Appsmith instance is operational. This endpoint does not require authentication and can be used to monitor self-hosted instances.

List Datasources

List all datasources configured in a workspace. Datasources represent connections to databases (PostgreSQL, MySQL, MongoDB, etc.) and APIs (REST, GraphQL) used by applications. Credentials are never exposed.

Export Application

Export an Appsmith application as a JSON object. The exported JSON contains the full application definition including pages, queries, JS objects, and widget configurations. Datasource credentials are excluded for security.

List Pages

List all pages in an Appsmith application. Pages are the main navigational units within an application, each containing widgets, queries, and JS objects.

Manage Application

Create, update, delete, publish, clone, or fork an Appsmith application. Provides full lifecycle management for applications within workspaces.

Get Current User

Retrieve the profile of the currently authenticated user, including their name, email, and role information.