Skip to main content
NocoDB logo
  • Category: databases
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 28
  • Triggers: 0
  • Slug: NOCODB
  • Version: 20261101_00

Tools

Slug: NOCODB_AUTH_METool 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

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: NOCODB_AUTH_PASSWORD_FORGOTInitiate a password reset for an account by email. The response may contain an error message, including for an HTTP 400 response, rather than confirmation that a reset email was sent.

Input Parameters

string
required
The email address of the registered user account. Must be a valid email format.

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: NOCODB_AUTH_SIGNOUTTool 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

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: NOCODB_CREATE_RECORD_COMMENTAdd a text comment to a NocoDB table record.

Input Parameters

string
Optional structured or string metadata for the comment.
string
Text of the comment to add to the record.
string
required
Unique identifier of the table containing the record.
string
required
Identifier of the record to comment on.
array
Files to attach to the comment, using NocoDB attachment objects.

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: NOCODB_DB_TABLE_SORT_GETTool 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

string
required
Unique identifier of the sort configuration 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: NOCODB_DB_VIEW_COLUMN_UPDATETool 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

boolean
Whether to show or hide the column in the view. Set to true to show, false to hide.
integer
The display order of the column in the view. Lower numbers appear first.
string
The width of the column when displayed in the view. Should be a string with ‘px’ suffix (e.g., ‘200px’).
string
required
The unique identifier of the view containing the column. An alphanumeric string prefixed with ‘vw’ or ‘v’.
string
required
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

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: NOCODB_DB_VIEW_DELETETool to delete a view from a NocoDB table. Use when you need to permanently remove a view. This action cannot be undone.

Input Parameters

string
required
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

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: NOCODB_DB_VIEW_ROW_DELETETool 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

string
Organization identifier. Defaults to ‘noco’ if not specified.
string
required
Unique identifier of the row to be deleted.
string
required
Name of the base/project containing the table.
string
required
Name of the view from which to delete the row.
string
required
Name of the table containing the row to delete.

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: NOCODB_INTEGRATIONS_INFOTool 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

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

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: NOCODB_INTEGRATIONS_LISTTool to retrieve all available integrations in NocoDB. Use when you need to list all integrations including AI, authentication, sync, and workflow-node types.

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: NOCODB_INTEGRATION_STORETool 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

object
required
Configuration object containing integration settings like API keys, models, and other parameters specific to the integration type
string
required
Unique identifier for the integration to store configuration

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: NOCODB_LIST_LINKED_RECORDSList records related to a source record through a NocoDB link field.

Input Parameters

string
Comma-separated fields to sort by; prefix a field with ’-’ for descending order.
integer
Maximum number of linked records to return.
string
NocoDB comparison expression used to filter linked records.
string
Comma-separated field names to include in each linked record.
integer
Number of linked records to skip for offset pagination.
string
required
Unique identifier of the table containing the source record.
string
required
Unique identifier of the source record.
Unique identifier of the link field that defines the relationship.

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: NOCODB_LIST_RECORD_COMMENTSList comments attached to a specified NocoDB table record.

Input Parameters

string
required
Unique identifier of the table containing the record.
string
required
Unique identifier of the record whose comments should be listed.

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: NOCODB_LIST_RECORDSList records from a NocoDB table with optional projection and filtering.

Input Parameters

string
Comma-separated fields to sort by. Prefix a field with ’-’ for descending order.
integer
Maximum number of records to return.
string
NocoDB comparison expression used to filter records.
string
Comma-separated field names to include in each record.
integer
Number of matching records to skip.
string
Unique identifier of the view whose configuration should be applied.
string
required
Unique identifier of the table whose records should be listed.

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: NOCODB_LIST_VIEW_COLUMNSList a NocoDB view’s column IDs, visibility, order, and width.

Input Parameters

string
required
Unique identifier of the view whose columns should be listed.

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: NOCODB_LIST_WORKSPACESList workspaces accessible to the authenticated user, primarily for NocoDB Cloud or multi-workspace deployments. Returns one server response, which may include pagination metadata.

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: NOCODB_NOTIFICATION_DELETETool to delete a notification for the authenticated user. Use when you need to remove a notification. This performs a soft-delete operation.

Input Parameters

string
required
The unique identifier of the notification to delete. An alphanumeric string that uniquely identifies a specific notification for the authenticated 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: NOCODB_NOTIFICATION_LISTTool 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

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

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: NOCODB_NOTIFICATION_POLLTool 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

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: NOCODB_PLUGIN_STATUSTool 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

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

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: NOCODB_PUBLIC_GROUPED_DATA_LISTRetrieve grouped records from a publicly shared NocoDB view by view UUID and column ID, with optional filtering, sorting, and pagination.

Input Parameters

string
Sort order for the grouped data. Format: columnName for ascending, -columnName for descending.
integer
Maximum number of grouped records to return. Used for pagination.
string
Filter condition to apply on the data in URL-encoded format.
integer
Number of records to skip before starting to return results. Used for pagination.
string
required
Unique identifier of the column to group data by.
string
required
Unique identifier (UUID) of the public shared view to retrieve grouped 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: NOCODB_STORAGE_UPLOAD_BY_URLTool 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

string
Storage path/scope for the uploaded files
array
required
Array of attachment objects to upload from URLs. Each object must contain at least a ‘url’ field.

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: NOCODB_TABLE_READTool to retrieve complete schema information for a specific table. Use when you need to understand table structure, field definitions, or available views.

Input Parameters

string
required
Unique identifier for the base containing the table
string
required
Unique identifier for the table 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: NOCODB_UPDATE_RECORDSUpdate field values for one or more identified records in a NocoDB table.

Input Parameters

array
required
Records to update. Each object must identify a record and contain the field values to replace.
string
required
The unique identifier of the table containing the records.

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: NOCODB_USER_PROFILE_UPDATETool 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

string
User’s last name.
string
User’s first name.
string
The display name for the user. Used to update how the user’s name appears in the interface.

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: NOCODB_UTILS_AGGREGATED_META_INFOGet aggregated NocoDB instance metadata, including base, user, shared base, and shared view counts and lists when available. An empty server response is returned as an empty metadata object.

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: NOCODB_UTILS_APP_HEALTHTool 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

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: NOCODB_UTILS_APP_INFOTool 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

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: NOCODB_UTILS_CLOUD_FEATURESTool 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

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: NOCODB_UTILS_COMMAND_PALETTETool 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

string
Optional search query to filter command suggestions.
string
Optional scope to filter command palette suggestions. Determines the context for available commands.

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: NOCODB_UTILS_ERROR_REPORTTool 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

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

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: NOCODB_UTILS_FEEDGet NocoDB product feed updates from sources including GitHub, YouTube, Twitter, and Cloud. Filter by source and use page and per-page settings to browse the feed.

Input Parameters

integer
Page number for pagination. Must be >= 1.
string ("github" | "youtube" | "twitter" | "cloud" | "all")
Specifies the feed source to retrieve. Valid values: ‘github’, ‘youtube’, ‘twitter’, ‘cloud’, or ‘all’.
integer
Number of items per page. Must be between 1 and 100.

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: NOCODB_UTILS_URL_TO_CONFIGTool 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

string
required
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

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: NOCODB_WORKSPACE_BASE_LISTTool 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

integer
Current page number for pagination. Must be >= 1.
integer
Number of items per page. Defaults to 25 if not specified.
string
required
Unique identifier for the workspace to list bases 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