NocoDB

Overview

NocoDB is a free and open source Airtable alternative that turns any database into a smart spreadsheet with REST APIs. With the NocoDB integration in SquadOS, your agents can programmatically manage workspaces, bases, tables, views, and records, as well as query integration metadata, notifications, and system information — all without opening the web UI.

• Composio documentation: docs.composio.dev/toolkits/nocodb

Authentication

This tool uses an API key (API_KEY) to connect.

You will need the following fields:

Field	Required	Description
api_key	Yes	API token generated in the NocoDB dashboard, used to authenticate all requests to the instance.

How to get credentials

1. Access your NocoDB instance (cloud at app.nocodb.com or self-hosted) and log in.
2. Click on your avatar or username in the bottom-left corner to open account settings.
3. Navigate to Team & Auth → API Tokens (in newer versions this may be under Settings → API Tokens).
4. Click Add New Token, give it a descriptive name (e.g., squados), and confirm.
5. Copy the generated token — this is the value to enter in the api_key field when connecting in SquadOS.

Tip

Create a dedicated token for SquadOS. That way, you can revoke it individually if needed without affecting other integrations that use the same account.

How to connect in SquadOS

1. Go to Tools in the side menu (/admin/tools).
2. Open the Available tab and search for NocoDB.
3. Click the card to open the details modal and hit Connect.
4. You’re taken to the secure connection page hosted by Composio, where you enter the API key obtained above.
5. Once done, you’re sent back to SquadOS with the account connected and the tool available to your agents. (Connection-flow details in Organization Tools.)

Available actions

Get User Info

NOCODB_AUTH_ME

Tool to get authenticated user information including email, name, roles, and profile details. Use when you need to verify user authentication or retrieve the current user’s profile information.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Forgot Password

NOCODB_AUTH_PASSWORD_FORGOT

Tool to initiate password reset process by sending a reset email to the user. Use when a user has forgotten their password and needs to receive a password reset link via email.

Input parameters

Name	Type	Required	Description
email	string	Yes	The email address of the registered user account. Must be a valid email format.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Sign Out User

NOCODB_AUTH_SIGNOUT

Tool to sign out the authenticated user and clear their refresh token from the database and cookie. Use when you need to invalidate a user’s authentication session and log them out of the NocoDB application.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Get Sort Metadata

NOCODB_DB_TABLE_SORT_GET

Tool to retrieve sort configuration by ID from NocoDB. Use when you need to get details about how data is ordered in a specific view.

Input parameters

Name	Type	Required	Description
sort_id	string	Yes	Unique identifier of the sort configuration to retrieve

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Update View Column

NOCODB_DB_VIEW_COLUMN_UPDATE

Tool to update a column configuration in a view. Use when you need to change column visibility, order, or width in a specific view.

Input parameters

Name	Type	Required	Description
show	boolean	No	Whether to show or hide the column in the view. Set to true to show, false to hide.
order	integer	No	The display order of the column in the view. Lower numbers appear first.
width	string	No	The width of the column when displayed in the view. Should be a string with ‘px’ suffix (e.g., ‘200px’).
viewId	string	Yes	The unique identifier of the view containing the column. An alphanumeric string prefixed with ‘vw’ or ‘v’.
columnId	string	Yes	The unique identifier of the view column configuration to update. An alphanumeric string prefixed with ‘nc’. This is the view column ID from the view columns list, not the table field ID.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Delete View

NOCODB_DB_VIEW_DELETE

Tool to delete a view from a NocoDB table. Use when you need to permanently remove a view. This action cannot be undone.

Input parameters

Name	Type	Required	Description
viewId	string	Yes	Unique View ID identifying the view to delete. An alphanumeric string prefixed with ‘v’ (e.g., vw_wtdg2meyig5l4q) with a maximum length of 20 characters.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Delete Table View Row

NOCODB_DB_VIEW_ROW_DELETE

Tool to delete a specific row from a table view in NocoDB. Use when you need to remove a single record from a view.

Input parameters

Name	Type	Required	Description
orgs	string	No	Organization identifier. Defaults to ‘noco’ if not specified.
rowId	string	Yes	Unique identifier of the row to be deleted.
baseName	string	Yes	Name of the base/project containing the table.
viewName	string	Yes	Name of the view from which to delete the row.
tableName	string	Yes	Name of the table containing the row to delete.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Get Integration Info

NOCODB_INTEGRATIONS_INFO

Tool to retrieve metadata for a specific NocoDB integration by type and subtype. Use when you need to get integration configuration schema, display information, or available capabilities for an integration.

Input parameters

Name	Type	Required	Description
type	string	Yes	The category/type of integration (e.g., ‘Database’, ‘ai’). Specifies the integration type classification.
subType	string	Yes	The specific variant within the integration type. For databases: ‘pg’ (PostgreSQL), ‘mysql2’ (MySQL), ‘sqlite3’ (SQLite), ‘snowflake’, ‘databricks’. For AI: ‘openai’, etc.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

List Integrations

NOCODB_INTEGRATIONS_LIST

Tool to retrieve all available integrations in NocoDB. Use when you need to list all integrations including AI, authentication, sync, and workflow-node types.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Store Integration Configuration

NOCODB_INTEGRATION_STORE

Tool to store configuration for a NocoDB integration. Use when you need to save or update integration settings like API keys, models, or other configuration parameters.

Input parameters

Name	Type	Required	Description
config	object	Yes	Configuration object containing integration settings like API keys, models, and other parameters specific to the integration type
integrationId	string	Yes	Unique identifier for the integration to store configuration

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

List Workspaces

NOCODB_LIST_WORKSPACES

Tool to list all workspaces accessible to the authenticated user. Use when you need to discover workspace_id before base operations, primarily relevant for NocoDB Cloud or multi-workspace deployments.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Delete Notification

NOCODB_NOTIFICATION_DELETE

Tool to delete a notification for the authenticated user. Use when you need to remove a notification. This performs a soft-delete operation.

Input parameters

Name	Type	Required	Description
notificationId	string	Yes	The unique identifier of the notification to delete. An alphanumeric string that uniquely identifies a specific notification for the authenticated user.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

List Notifications

NOCODB_NOTIFICATION_LIST

Tool to retrieve paginated notification records for the authenticated user. Use when you need to list notifications with optional filtering by read status and pagination support. Only returns notifications that haven’t been soft-deleted.

Input parameters

Name	Type	Required	Description
limit	integer	No	Maximum number of notifications to return per request. Defaults to 10 if not specified.
isRead	boolean	No	Filter notifications by read status. Pass true for read notifications, false for unread. If omitted, returns all notifications.
offset	integer	No	Number of notifications to skip for pagination. Defaults to 0 if not specified.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Poll Notifications

NOCODB_NOTIFICATION_POLL

Tool to poll for notifications using long-polling mechanism. Use when you need to check for new notifications for the authenticated user. The connection is maintained for up to 30 seconds; if no notification arrives, returns status ‘refresh’ and the client should poll again.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Get Plugin Status

NOCODB_PLUGIN_STATUS

Tool to check if a NocoDB plugin is active or not. Use when you need to verify the operational status of a specific plugin by its identifier.

Input parameters

Name	Type	Required	Description
pluginId	string	Yes	Unique identifier for the plugin to check status (e.g., ‘S3’, ‘SES’, ‘Backblaze’, ‘Vultr’, ‘OvhCloud’, ‘LinodeObjectStorage’, ‘UpcloudObjectStorage’, ‘Minio’, ‘GCS’, ‘Spaces’, ‘Scaleway’).

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

List Public Shared View Grouped Data

NOCODB_PUBLIC_GROUPED_DATA_LIST

Tool to retrieve grouped data from a publicly shared NocoDB view. Use when you need to access grouped records from a public shared view without authentication.

Input parameters

Name	Type	Required	Description
sort	string	No	Sort order for the grouped data. Format: columnName for ascending, -columnName for descending.
limit	integer	No	Maximum number of grouped records to return. Used for pagination.
where	string	No	Filter condition to apply on the data in URL-encoded format.
offset	integer	No	Number of records to skip before starting to return results. Used for pagination.
columnId	string	Yes	Unique identifier of the column to group data by.
sharedViewUuid	string	Yes	Unique identifier (UUID) of the public shared view to retrieve grouped data from.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Upload Attachments by URL

NOCODB_STORAGE_UPLOAD_BY_URL

Tool to upload attachments from remote URLs to NocoDB storage. Use when you need to import files from external URLs or migrate attachments from other platforms like Airtable. The server fetches files from provided URLs and stores them in configured storage.

Input parameters

Name	Type	Required	Description
path	string	No	Storage path/scope for the uploaded files
attachments	array	Yes	Array of attachment objects to upload from URLs. Each object must contain at least a ‘url’ field.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Get Table Schema

NOCODB_TABLE_READ

Tool to retrieve complete schema information for a specific table. Use when you need to understand table structure, field definitions, or available views.

Input parameters

Name	Type	Required	Description
base_id	string	Yes	Unique identifier for the base containing the table
table_id	string	Yes	Unique identifier for the table to retrieve

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Update User Profile

NOCODB_USER_PROFILE_UPDATE

Tool to update authenticated user’s profile information including display name, first name, and last name. Use when you need to modify the current user’s profile details in NocoDB.

Input parameters

Name	Type	Required	Description
lastname	string	No	User’s last name.
firstname	string	No	User’s first name.
display_name	string	No	The display name for the user. Used to update how the user’s name appears in the interface.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Get Aggregated Meta Info

NOCODB_UTILS_AGGREGATED_META_INFO

Tool to get aggregated meta information such as tableCount, dbViewCount, viewCount and other statistics about the NocoDB instance. Use when you need an overview of the system’s data structure and usage metrics.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Get Application Health Status

NOCODB_UTILS_APP_HEALTH

Tool to get the NocoDB application health status. Use when you need to check if the application is running and responsive, typically for load balancers or monitoring systems.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Get Application Info

NOCODB_UTILS_APP_INFO

Tool to get comprehensive NocoDB application information including authentication settings, version, limits, and deployment configuration. Use when you need to discover application capabilities, feature flags, or system configuration.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Get Cloud Features

NOCODB_UTILS_CLOUD_FEATURES

Tool to get NocoDB Cloud features. Use when you need to retrieve available cloud-specific features and capabilities, including their availability status and highlight information.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Get Command Palette Suggestions

NOCODB_UTILS_COMMAND_PALETTE

Tool to get dynamic command palette suggestions based on scope. Use when you need to retrieve available commands and actions for the NocoDB interface.

Input parameters

Name	Type	Required	Description
query	string	No	Optional search query to filter command suggestions.
scope	string	No	Optional scope to filter command palette suggestions. Determines the context for available commands.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Report Error

NOCODB_UTILS_ERROR_REPORT

Tool to report errors to NocoDB’s error tracking system. Use when you need to submit error reports including error type, message, stack trace, and timestamp for monitoring and debugging purposes.

Input parameters

Name	Type	Required	Description
error	string	Yes	Error name or type identifier. Provides a concise label for the error category.
stack	string	No	Stack trace or call stack showing the sequence of function calls leading to the error. Helps in debugging.
message	string	Yes	Detailed error message describing what went wrong. Should be human-readable and informative.
timestamp	string	No	ISO 8601 timestamp indicating when the error occurred. If not provided, the server may use current time.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Get Product Feed

NOCODB_UTILS_FEED

Tool to get NocoDB product feed from social media sources including GitHub, YouTube, Twitter, and Cloud. Use when you need to retrieve social media updates and content from NocoDB’s various channels. Supports filtering by feed source and pagination.

Input parameters

Name	Type	Required	Description
page	integer	No	Page number for pagination. Must be >= 1.
type	string	No	Specifies the feed source to retrieve. Valid values: ‘github’, ‘youtube’, ‘twitter’, ‘cloud’, or ‘all’.
per_page	integer	No	Number of items per page. Must be between 1 and 100.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Convert URL to Database Config

NOCODB_UTILS_URL_TO_CONFIG

Tool to convert JDBC URL or database connection URL to connection configuration object. Use when you need to parse and extract database connection parameters from a URL string for configuration purposes.

Input parameters

Name	Type	Required	Description
url	string	Yes	Database connection URL in JDBC format or standard format (e.g., ‘jdbc:mysql://localhost:3306/mydb?user=root&password=test’, ‘pg://user:pass@host:5432/dbname’, ‘sqlite://path/to/db.db’).

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

List Workspace Bases

NOCODB_WORKSPACE_BASE_LIST

Tool to list all bases in a NocoDB workspace. Use when you need to retrieve bases associated with a specific workspace. Supports pagination via page and pageSize parameters.

Input parameters

Name	Type	Required	Description
page	integer	No	Current page number for pagination. Must be >= 1.
pageSize	integer	No	Number of items per page. Defaults to 25 if not specified.
workspaceId	string	Yes	Unique identifier for the workspace to list bases from.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not