Skip to main content
Knack logo
  • Category: databases
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 10
  • Triggers: 0
  • Slug: KNACK
  • Version: 20260615_00

Tools

Slug: KNACK_CREATE_OBJECT_RECORDTool to create a new record in a specific Knack object. Use when you need to add new data to a Knack database object. Requires object-based API key authentication.

Input Parameters

object
required
Dictionary of field keys and their values. Keys must match your Knack object’s field keys (e.g., ‘field_1’, ‘field_2’). Values can be strings, numbers, objects, or arrays depending on the field type. For name fields, use {‘first’: ‘John’, ‘last’: ‘Doe’}. For email fields, use {‘email’: ‘user@example.com’}.
string
required
The object key identifier (e.g., ‘object_1’, ‘object_2’). This identifies which Knack object to create the record in.

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: KNACK_CREATE_VIEW_RECORDTool to create a new record through a form view in Knack. Use when you need to add a record to a Knack object using a form view interface. Only fields that exist in the form will be used, and any record rules configured on the form will be triggered.

Input Parameters

string
required
The view key for the form view through which to create the record (e.g., ‘view_12’).
string
required
The scene/page key where the form view is located (e.g., ‘scene_13’).
object
required
JSON object containing field keys and their values. Field keys must match the fields defined in the form view (e.g., {‘field_1’: {‘first’: ‘John’, ‘last’: ‘Doe’}, ‘field_2’: ‘john@example.com’}). Only fields that exist in the form will be used.
string
User token for login-protected pages. Only required if the form view requires authentication.

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: KNACK_DELETE_OBJECT_RECORDTool to delete a single record from a specific Knack object by its ID. Use when you need to permanently remove a record from an object. This action is permanent and cannot be undone. Requires API key authentication (X-Knack-Application-Id and X-Knack-REST-API-KEY headers).

Input Parameters

string
required
The unique ID of the record to delete. This operation is permanent and cannot be undone.
string
required
The object key (e.g., object_1, object_2). This identifies which object the record belongs to.

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: KNACK_DELETE_VIEW_RECORDTool to delete a record through a view that contains a delete link. Works with tables, lists, searches, calendars, and details views. This operation is permanent and cannot be undone. Use only after confirming the correct scene_key, view_key, and record_id.

Input Parameters

string
required
The view key for a view with delete link (e.g., view_2). Must be a view that contains delete functionality.
string
required
The record ID to delete. This operation is permanent and cannot be undone.
string
required
The scene/page key (e.g., scene_10). Identifies the page containing the view.

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: KNACK_GET_OBJECT_RECORDTool to retrieve a single record by its ID from a specific Knack object. Returns the complete record with all field values in both formatted and raw formats. Use this for object-based access which requires API key authentication.

Input Parameters

string
required
The unique record ID to retrieve (e.g., ‘58643557d1ea9432222f3cbb’). This is a 24-character hexadecimal string.
string
required
The object key identifier (e.g., ‘object_1’, ‘object_2’). This can be found in your Knack application’s API settings or builder 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: KNACK_LIST_OBJECT_RECORDSTool to retrieve multiple records from a specific Knack object (table). Returns up to 1000 records per page with pagination support. Use this for object-based access which requires API key authentication and provides full access to all fields and records. Supports filtering by field values and sorting by field keys.

Input Parameters

integer
Page number for pagination (default 1). Use this to navigate through multiple pages of results.
string
URL-encoded JSON filter object. Must contain ‘match’ (and/or) and ‘rules’ array. Example: {“match”:“and”,“rules”:[{“field”:“field_1”,“operator”:“is”,“value”:“test”}]}
string
required
The object key identifier (e.g., object_1, object_2). This identifies which Knack object (table) to retrieve records from.
string
Field key to sort results by (e.g., field_25). Must be a valid field key from the object.
string ("asc" | "desc")
Sort order enumeration for records.
integer
Number of records per page (default 25, max 1000). Controls how many records are returned in a single request.

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: KNACK_LIST_VIEW_RECORDSTool to retrieve multiple records from a specific Knack view (tables, lists, searches, calendars). Use when you need to fetch data from a view with pagination support. Returns only fields included in the view configuration.

Input Parameters

integer
Page number for pagination. Defaults to 1 if not specified.
string
required
The view key (e.g., view_1, view_11). This identifies the specific view (table, list, search, or calendar) to retrieve records from.
string
required
The scene/page key (e.g., scene_1). This identifies the page containing the view.
integer
Number of records per page. Maximum is 1000. Defaults to 25 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: KNACK_UPDATE_OBJECT_RECORDTool to update an existing record in a specific Knack object. Use when you need to modify field values in an existing record. Only fields provided in the request will be updated; all other fields remain unchanged.

Input Parameters

object
required
Dictionary of field keys and their values to update. Only fields included in this dictionary will be modified; all other fields remain unchanged. Keys must match your Knack object’s field keys (e.g., ‘field_1’, ‘field_4’). Values can be strings, numbers, objects, or arrays depending on the field type.
string
required
The unique record ID to update (e.g., ‘67e1e50c2fa13b511d7770aa’). This is a 24-character hexadecimal string.
string
required
The object key identifier (e.g., ‘object_1’, ‘object_2’). This identifies which Knack object contains the record to update.

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: KNACK_UPLOAD_FILETool to upload a file to a Knack application. This is step 1 of a two-step process - after uploading, use the returned file ID when creating or updating a record with a file field.

Input Parameters

object
required
The file to upload to Knack.
string
required
Your Knack application ID. This identifies which application to upload the file to.

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: KNACK_UPLOAD_IMAGETool to upload an image to a Knack application. This is the first step in a two-step process - after uploading, use the returned file ID when creating or updating a record with an image field. Use when you need to attach images to Knack records.

Input Parameters

object
required
The image file to upload.
string
required
Your Knack application ID. This identifies which application to upload the image to.

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