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 self-hosted Business workflow support. An HTTP acknowledgement does not confirm completion.

Query Audit Logs

DEPRECATED — the historical audit-log route and filters are not verified against the current enterprise API contract. Use Admin Settings > Others > Audit logs on a Business instance

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 datasource metadata in a workspace through the version-sensitive dashboard API. Returns only identifiers, names, connector metadata and native validity flags; connection configuration is omitted.

Export Application

Export an Appsmith application to a downloadable JSON file. Known decrypted credential fields are removed. Query text, widget configuration and embedded business data can remain sensitive.

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. Uses version-sensitive dashboard session endpoints. Publishing or public access can expose data; updates to name and public access are separate writes. Exact get reads the authorized base-application inventory, excluding branch-specific discovery.

Get Current User

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