Airtable API
Tools that enable LLMs to interact directly with the airtable API.
Arcade Toolkit for Airtable API
The Airtable API toolkit allows LLMs to seamlessly interact with Airtable, enabling the management of records, collaborators, and enterprise accounts efficiently.
Capabilities
- Manage Airtable bases, records, and tables with ease.
- Collaborator management, including permissions and user roles within workspaces and interfaces.
- Support for batch operations to manipulate multiple records and users.
- Facilitate webhooks, comments, and audit log requests for enhanced functionality.
OAuth
Provider: Airtable Scopes: data.recordComments:read, data.recordComments:write, data.records:read, data.records:write, enterprise.account:read, and more.
Secrets
No secret types or names are required for this toolkit.
Available tools(96)
| Tool name | Description | Secrets | |
|---|---|---|---|
Add a collaborator to an Airtable base.
Use this tool to add a new collaborator to a specified Airtable base. It facilitates inviting one collaborator at a time.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Add a collaborator to an Airtable interface.
This tool is used to add a new collaborator to a specific interface in Airtable. Call this when you need to give a user access to an interface within a particular base.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Creates a comment on a specified record.
Use this tool to add a comment on a specific record in Airtable. Supports mentioning users within the comment.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Add a collaborator to an Airtable workspace.
Use this tool to add a single collaborator to a specified Airtable workspace. This function is called when you need to invite someone to join your workspace as a collaborator.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Retrieve a single record from an Airtable table.
This tool is used to fetch a specific record from an Airtable table using its Record ID. It will return the record if it can be located within the table or elsewhere in the same base. | |||
Batch manage users in enterprise accounts.
Use this tool to manage enterprise account users by ID or email. Ideal for updates or changing user emails. Best suited for handling up to 10 users per batch to optimize performance and avoid timeouts.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Batch manage user membership in enterprise accounts.
This tool allows changing a user's membership status between unmanaged and organization member in an enterprise account. It handles membership updates in batches and returns outcomes for each user processed, including any errors encountered. Use when managing user roles within organizations.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Batch move user groups between enterprise accounts.
Use this tool to transfer user groups between two enterprise accounts within the same organization, provided the accounts have the Enterprise Hub feature enabled. The tool ensures compliance with organizational invite settings, potentially removing non-org unit members during the move.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Update or upsert multiple records in an Airtable table.
Use this tool to perform a destructive update on multiple records in an Airtable table. Provide up to 10 record objects, each with an ID and fields to update. Optionally, perform upserts by including fields to merge on, allowing records to be created if no matching records are found. The response will specify which records were updated or created.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Create a new Airtable base with specified tables and schema.
This tool creates a new base in Airtable with the provided tables and returns the schema for the newly created base. At least one table and field must be specified, with fields having unique names within the table. A default grid view is created for each table.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Creates a new column in an Airtable table and returns its schema.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Create multiple records in an Airtable base.
Use this tool to create up to 10 records in a specified Airtable base and table. Utilize table IDs for stability, and include record objects with cell values. Returns a unique array of newly created record IDs if successful.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Create a new table in Airtable and return its schema.
This tool creates a new table in Airtable and provides the schema for the newly created table. At least one field must be specified, and fields must have unique, case-insensitive names within the table. The first field serves as the primary field. A default view with all fields visible is created.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Create a new webhook in a specified Airtable base.
Use this tool to create a webhook in a specified Airtable base with the option to receive payload notifications. Note that webhooks are limited to 10 per base, and OAuth integrations can create up to 2. Webhooks expire in 7 days but can be refreshed if still active. Creator level permissions are required.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Create a new workspace in Airtable.
This tool creates a new workspace in Airtable within a specified enterprise account. It returns the ID of the newly created workspace. The user must be an active admin of the enterprise account to successfully create the workspace.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Initiate the creation of an audit log request.
Starts the processing necessary to retrieve audit logs and returns an ID to track and download the logs later. For new cases, prefer using the audit log events API.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Create a descendant enterprise account in Airtable.
This tool creates a descendant enterprise (organizational unit) account under a root enterprise account in Airtable. It should be called when you need to organize accounts hierarchically within the Enterprise Hub. Ensure the root account supports descendant creation.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Initiate an eDiscovery export request.
Use this tool to create an eDiscovery export request in Airtable. It returns an ID to check the status and download the export.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Create a new SCIM group with no members.
This tool creates a new SCIM group without any members. It should be called when there's a need to set up a new group structure. To add members, use patch or put group endpoints.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Create a new user using SCIM protocol.
This tool creates a new SCIM user, marking them as active and assigning an email matching the username. It's intended for SSO environments only. Beware of potential conflicts with existing non-enterprise users.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Delete a specified Airtable base.
Use this tool to delete an Airtable base by specifying the base ID. Deleted bases can be restored by workspace owners within the retention period set by the billing plan. | |||
Delete a block installation in Airtable, recoverable later.
Use this tool when you need to delete a block installation from an Airtable base. The deletion is not permanent and can be recovered if needed. | |||
Deletes a single record from an Airtable base and table.
Use this tool to delete a specific record from a specified table within an Airtable base by providing the base ID, table ID or name, and record ID. | |||
Permanently delete a share from an Airtable base.
This tool permanently deletes a share from an Airtable base. It should be used when you need to remove a share entirely, with no recovery option available. | |||
Deletes a specific view in Airtable by ID.
Use this tool to delete a specific view from an Airtable base. Provide the base ID and view ID to perform the deletion. |
Selected tools
No tools selected.
Click "Show all tools" to add tools.
Requirements
Select tools to see requirements
AirtableApi.AddBaseCollaborator
Add a collaborator to an Airtable base. Use this tool to add a new collaborator to a specified Airtable base. It facilitates inviting one collaborator at a time. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
base_id | string | Optional | The ID of the Airtable base to which the collaborator will be added. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'add-base-collaborator'.AirtableApi.AddCollaboratorToAirtableInterface
Add a collaborator to an Airtable interface. This tool is used to add a new collaborator to a specific interface in Airtable. Call this when you need to give a user access to an interface within a particular base. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
airtable_base_id | string | Optional | The unique identifier for the Airtable base where the interface is located. This helps specify which base the collaborator will be added to. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
page_bundle_id | string | Optional | The unique identifier for the specific interface page bundle where the collaborator will be added. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'add-interface-collaborator'.AirtableApi.AddRecordComment
Creates a comment on a specified record. Use this tool to add a comment on a specific record in Airtable. Supports mentioning users within the comment. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
base_identifier | string | Optional | The unique identifier of the Airtable base where the record is located. This is required to specify which base contains the record you want to comment on. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
table_identifier | string | Optional | The ID or name of the table where the record is located. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
record_identifier | string | Optional | The unique identifier of the record where the comment will be added. This value specifies which record in Airtable will receive the comment. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'create-comment'.AirtableApi.AddWorkspaceCollaborator
Add a collaborator to an Airtable workspace. Use this tool to add a single collaborator to a specified Airtable workspace. This function is called when you need to invite someone to join your workspace as a collaborator. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
workspace_id | string | Optional | The unique identifier of the Airtable workspace where the collaborator will be added. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'add-workspace-collaborator'.AirtableApi.AirtableGetRecord
Retrieve a single record from an Airtable table. This tool is used to fetch a specific record from an Airtable table using its Record ID. It will return the record if it can be located within the table or elsewhere in the same base.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
airtable_base_id | string | Required | The unique identifier for the Airtable base containing the table from which to retrieve the record. This ID is required to locate the correct base and perform the record search. |
record_id | string | Required | The unique identifier for the record you wish to retrieve from the Airtable table. This ID should be valid and correspond to a record within the specified base. |
table_identifier | string | Required | Specify the table's ID or name from which to retrieve the record. |
cell_format | string | Optional | Specify how cell values should be formatted. Options may include 'json' or 'string'. |
return_fields_by_field_id | boolean | Optional | If true, fields are returned by Field ID instead of names. |
Requirements
Output
json— Response from the API endpoint 'get-record'.AirtableApi.BatchManageEnterpriseUsers
Batch manage users in enterprise accounts. Use this tool to manage enterprise account users by ID or email. Ideal for updates or changing user emails. Best suited for handling up to 10 users per batch to optimize performance and avoid timeouts. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
enterprise_account_id | string | Optional | The unique identifier for the enterprise account to manage users within. This must be provided as a string. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'manage-user-batched'.AirtableApi.BatchManageUserMembership
Batch manage user membership in enterprise accounts. This tool allows changing a user's membership status between unmanaged and organization member in an enterprise account. It handles membership updates in batches and returns outcomes for each user processed, including any errors encountered. Use when managing user roles within organizations. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
enterprise_account_id | string | Optional | The unique identifier of the enterprise account in which user membership will be managed. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'manage-user-membership'.AirtableApi.BatchMoveUserGroupsBetweenAccounts
Batch move user groups between enterprise accounts. Use this tool to transfer user groups between two enterprise accounts within the same organization, provided the accounts have the Enterprise Hub feature enabled. The tool ensures compliance with organizational invite settings, potentially removing non-org unit members during the move. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
target_enterprise_account_id | string | Optional | The ID of the target enterprise account to which user groups are being moved. Must belong to the same organization and have the Enterprise Hub feature enabled. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'move-user-groups'.AirtableApi.BulkUpdateAirtable
Update or upsert multiple records in an Airtable table. Use this tool to perform a destructive update on multiple records in an Airtable table. Provide up to 10 record objects, each with an ID and fields to update. Optionally, perform upserts by including fields to merge on, allowing records to be created if no matching records are found. The response will specify which records were updated or created. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
base_id | string | Optional | The unique ID of the Airtable base containing the records to update. This is required to specify the target base. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
table_identifier | string | Optional | The table ID or name in Airtable where the records will be updated. Use the table ID to avoid changes if the name changes. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'update-multiple-records-put'.AirtableApi.CreateAirtableBase
Create a new Airtable base with specified tables and schema. This tool creates a new base in Airtable with the provided tables and returns the schema for the newly created base. At least one table and field must be specified, with fields having unique names within the table. A default grid view is created for each table. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'create-base'.AirtableApi.CreateAirtableField
Creates a new column in an Airtable table and returns its schema. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
airtable_base_id | string | Optional | The unique identifier for the Airtable base containing the table. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
table_id | string | Optional | The unique identifier of the table where the new column will be created. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'create-field'.AirtableApi.CreateAirtableRecords
Create multiple records in an Airtable base. Use this tool to create up to 10 records in a specified Airtable base and table. Utilize table IDs for stability, and include record objects with cell values. Returns a unique array of newly created record IDs if successful. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
base_id | string | Optional | The unique identifier for the Airtable base where records will be created. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
table_id_or_name | string | Optional | The ID or name of the Airtable table where records will be created. Using the table ID is recommended for consistency. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'create-records'.AirtableApi.CreateAirtableTable
Create a new table in Airtable and return its schema. This tool creates a new table in Airtable and provides the schema for the newly created table. At least one field must be specified, and fields must have unique, case-insensitive names within the table. The first field serves as the primary field. A default view with all fields visible is created. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
airtable_base_id | string | Optional | The identifier for the Airtable base where the table will be created. Must be a string. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'create-table'.AirtableApi.CreateAirtableWebhook
Create a new webhook in a specified Airtable base. Use this tool to create a webhook in a specified Airtable base with the option to receive payload notifications. Note that webhooks are limited to 10 per base, and OAuth integrations can create up to 2. Webhooks expire in 7 days but can be refreshed if still active. Creator level permissions are required. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
base_id | string | Optional | The ID of the Airtable base where the webhook will be created. It should be a string. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'create-a-webhook'.AirtableApi.CreateAirtableWorkspace
Create a new workspace in Airtable. This tool creates a new workspace in Airtable within a specified enterprise account. It returns the ID of the newly created workspace. The user must be an active admin of the enterprise account to successfully create the workspace. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'create-workspace'.AirtableApi.CreateAuditLogRequest
Initiate the creation of an audit log request. Starts the processing necessary to retrieve audit logs and returns an ID to track and download the logs later. For new cases, prefer using the audit log events API. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
enterprise_account_id | string | Optional | The ID of the enterprise account for which the audit log is being requested. Necessary to initiate the log request process. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'create-audit-log-request'.AirtableApi.CreateDescendantEnterpriseAccount
Create a descendant enterprise account in Airtable. This tool creates a descendant enterprise (organizational unit) account under a root enterprise account in Airtable. It should be called when you need to organize accounts hierarchically within the Enterprise Hub. Ensure the root account supports descendant creation. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
enterprise_account_id | string | Optional | The ID of the root enterprise account for which to create a descendant. This account must have Enterprise Hub enabled. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'create-descendant-enterprise'.AirtableApi.CreateEdiscoveryExport
Initiate an eDiscovery export request. Use this tool to create an eDiscovery export request in Airtable. It returns an ID to check the status and download the export. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
enterprise_account_id | string | Optional | The unique identifier for the enterprise account. Required for creating an eDiscovery export. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'create-ediscovery-export'.AirtableApi.CreateScimGroup
Create a new SCIM group with no members. This tool creates a new SCIM group without any members. It should be called when there's a need to set up a new group structure. To add members, use patch or put group endpoints. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'create-scim-group'.AirtableApi.CreateScimUser
Create a new user using SCIM protocol. This tool creates a new SCIM user, marking them as active and assigning an email matching the username. It's intended for SSO environments only. Beware of potential conflicts with existing non-enterprise users. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'create-scim-user'.AirtableApi.DeleteAirtableBase
Delete a specified Airtable base. Use this tool to delete an Airtable base by specifying the base ID. Deleted bases can be restored by workspace owners within the retention period set by the billing plan.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
base_id | string | Required | The unique identifier of the base you want to delete. This ID is required to perform the deletion. |
Requirements
Output
json— Response from the API endpoint 'delete-base'.AirtableApi.DeleteAirtableBlockInstallation
Delete a block installation in Airtable, recoverable later. Use this tool when you need to delete a block installation from an Airtable base. The deletion is not permanent and can be recovered if needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
airtable_base_id | string | Required | The unique identifier for the Airtable base from which the block installation will be deleted. |
block_installation_id | string | Required | The unique identifier of the block installation to be deleted. This is required to specify which block installation to remove. |
Requirements
Output
json— Response from the API endpoint 'delete-block-installation'.AirtableApi.DeleteAirtableRecord
Deletes a single record from an Airtable base and table. Use this tool to delete a specific record from a specified table within an Airtable base by providing the base ID, table ID or name, and record ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
airtable_base_id | string | Required | The unique identifier for the Airtable base from which the record will be deleted. This ID is required to specify the correct base. |
record_id | string | Required | The unique identifier of the record to be deleted from the specified table in Airtable. |
table_identifier | string | Required | The ID or name of the Airtable table from which the record should be deleted. This specifies which table within the base to target. |
Requirements
Output
json— Response from the API endpoint 'delete-record'.AirtableApi.DeleteAirtableView
Deletes a specific view in Airtable by ID. Use this tool to delete a specific view from an Airtable base. Provide the base ID and view ID to perform the deletion.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
airtable_base_id | string | Required | The ID of the Airtable base from which the view will be deleted. Must be a valid string identifier. |
view_identifier | string | Required | The unique identifier of the Airtable view to delete. Required to specify which view to remove. |
Requirements
Output
json— Response from the API endpoint 'delete-view'.AirtableApi.DeleteAirtableWebhook
Deletes a webhook in Airtable with required permissions. Use this tool to delete an existing webhook in Airtable. Requires creator level permissions to perform the action.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
airtable_base_id | string | Required | The unique ID of the Airtable base where the webhook is to be deleted. This is required to specify the target base. |
webhook_id | string | Required | The unique identifier for the webhook to be deleted. This string is required to specify which webhook will be removed. |
Requirements
Output
json— Response from the API endpoint 'delete-a-webhook'.AirtableApi.DeleteBaseInvite
Delete an outstanding base invite. Use this tool to delete an outstanding base invite by specifying the base and invite IDs. It is useful for managing and revoking access invitations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
base_id | string | Required | The unique identifier of the base from which the invite should be deleted. |
invite_id | string | Required | The unique identifier for the invite to be deleted. Ensure this is an outstanding invite. |
Requirements
Output
json— Response from the API endpoint 'delete-base-invite'.AirtableApi.DeleteCommentFromRecord
Delete a comment from a record in Airtable. Use this tool to delete a specific comment from a record in Airtable. Non-admin users can only delete their own comments, while Enterprise Admins can delete any comment. Call this when you need to manage comments on records.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
airtable_base_id | string | Required | The ID of the Airtable base. This is required to identify which base the comment belongs to. |
comment_id_to_delete | string | Required | The unique identifier of the comment to be deleted. Required for deletion. |
record_id | string | Required | The unique identifier for the record from which the comment will be deleted. |
table_id_or_name | string | Required | The ID or name of the table containing the record from which the comment will be deleted. |
Requirements
Output
json— Response from the API endpoint 'delete-comment'.AirtableApi.DeleteEnterpriseUser
Deletes an enterprise user by ID. Use this tool to delete users from an enterprise account, including both internal and managed users. Provide the specific enterprise account ID and user ID for successful deletion.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
enterprise_account_id | string | Required | The unique identifier for the enterprise account containing the user to be deleted. This is required for specifying the account context of the user. |
user_id | string | Required | The unique identifier of the user to be deleted from the enterprise account. |
Requirements
Output
json— Response from the API endpoint 'delete-user-by-id'.AirtableApi.DeleteInterfaceInvite
Delete an outstanding interface invite in Airtable. Delete an interface invite that is still outstanding in Airtable using the specified base ID, interface ID, and invite ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
base_identifier | string | Required | The unique identifier for the Airtable base from which the invite will be deleted. |
invite_id | string | Required | The identifier of the outstanding interface invite to be deleted. Must be a valid string representing the invite ID. |
page_bundle_id | string | Required | The unique ID of the interface page bundle to identify which interface's invite to delete. |
Requirements
Output
json— Response from the API endpoint 'delete-interface-invite'.AirtableApi.DeleteMultipleRecords
Delete multiple records from an Airtable table. Use this tool to delete multiple records in an Airtable table by providing an array of record IDs. It's useful for batch operations where several entries need to be removed simultaneously.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
base_id | string | Required | The unique identifier of the Airtable base containing the records to be deleted. |
table_identifier | string | Required | The unique identifier or name of the Airtable table from which records are to be deleted. |
record_ids_to_delete | array<string> | Optional | An array of record IDs to delete from the table. Each ID should be a string. |
Requirements
Output
json— Response from the API endpoint 'delete-multiple-records'.AirtableApi.DeleteRecordsByPrimaryKeys
Delete records from a HyperDB table using primary keys. Use this tool to delete records from a HyperDB table by providing the primary keys. It should be called when you need to remove entries from the table based on specific key matches. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
enterprise_account_id | string | Optional | The unique identifier for the enterprise account. Required to access the correct HyperDB table. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
data_table_id | string | Optional | The unique identifier for the target HyperDB table from which records will be deleted. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'hyperdb-delete-records-by-primary-keys'.AirtableApi.DeleteScimGroup
Delete a SCIM Group from Airtable. This tool deletes a specified SCIM Group in Airtable, useful for managing group memberships and access control.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
group_id | string | Required | The unique identifier of the SCIM Group to be deleted from Airtable. |
Requirements
Output
json— Response from the API endpoint 'delete-scim-group'.AirtableApi.DeleteScimUser
Delete a SCIM user from the system. The tool deletes a single SCIM user, except the admin owning the token or the sole owner of a multi-collaborator workspace. Refer to the SCIM specification for more details.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
scim_user_id | string | Required | Unique identifier for the SCIM user to delete. Cannot be the admin using the authentication token or the sole owner of a multi-collaborator workspace. |
Requirements
Output
json— Response from the API endpoint 'delete-scim-user'.AirtableApi.DeleteUsersByEmail
Delete multiple users identified by their email addresses. This tool deletes multiple users by their email addresses within a specified enterprise account. Use it when you need to remove several users efficiently.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
enterprise_account_id | string | Required | The unique ID of the enterprise account from which users will be deleted. Required for specifying the target enterprise. |
email_addresses | array<string> | Optional | An array of email addresses of users to be deleted. Each email must be a valid string. |
Requirements
Output
json— Response from the API endpoint 'delete-users-by-email'.AirtableApi.DeleteWorkspace
Deletes a specified Airtable workspace. Use this tool to delete a specific Airtable workspace. Ensure there are no important bases in the workspace before deletion or transfer them to another workspace. Deleted workspaces can be restored within the retention period from the Trash UI if the user is the workspace owner.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
workspace_id | string | Required | The unique identifier of the workspace to delete. Ensure no important data is lost before proceeding. |
Requirements
Output
json— Response from the API endpoint 'delete-workspace'.AirtableApi.DeleteWorkspaceInvite
Delete a workspace invite. Use this tool to delete an invitation to a workspace by specifying the workspace and invite IDs. This is useful for revoking access that has been granted but not yet accepted.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
invite_id | string | Required | The unique identifier of the workspace invite to delete. |
workspace_id | string | Required | The ID of the workspace from which the invite will be deleted. This is required to specify which workspace's invite is being revoked. |
Requirements
Output
json— Response from the API endpoint 'delete-workspace-invite'.AirtableApi.ExtendWebhookExpiration
Extend the expiration time of an active webhook. Use this tool to extend the life of an active webhook in Airtable by 7 days. Requires Creator level permissions and applies only to active webhooks with an expiration time.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
airtable_base_id | string | Required | The unique identifier for the Airtable base containing the webhook. Required for extending the webhook's expiration. |
webhook_identifier | string | Required | The ID of the webhook to extend. This must be a string representing the specific webhook you wish to refresh. |
Requirements
Output
json— Response from the API endpoint 'refresh-a-webhook'.AirtableApi.FetchScimGroup
Retrieve details of a specific SCIM Group by ID. This tool retrieves details of a specific group as a SCIM Group object using the group's ID. It should be called when there's a need to access or display information about a specific group managed within the SCIM system.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
scim_group_id | string | Required | The unique identifier of the SCIM Group to retrieve. |
Requirements
Output
json— Response from the API endpoint 'get-scim-group'.AirtableApi.GetAirtableBaseSchema
Retrieve the schema of tables in an Airtable base. Use this tool to get the schema details of all tables within a specific Airtable base. It is useful for understanding the structure and fields of the tables in the specified base.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
airtable_base_id | string | Required | The unique identifier for the Airtable base whose schema is being requested. This ID can be found in the URL of the base when accessed in Airtable. |
fields_to_include | array<string> | Optional | A list of specific fields to include in the schema response. Each field should be a string representing the field name. |
Requirements
Output
json— Response from the API endpoint 'get-base-schema'.AirtableApi.GetAirtableChangeEvents
Retrieve change events for Airtable enterprise bases. Use this tool to get change events for enterprise bases in Airtable. These events are accessible for 14 days and require change event features to be enabled in your account settings.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
enterprise_account_id | string | Required | The unique identifier for the enterprise account. This ID is required to retrieve the change events specific to the account. |
end_time | string | Optional | The end time for retrieving change events in ISO 8601 format (e.g., '2023-01-01T23:59:59Z'). |
page_size_limit | number | Optional | Specifies the maximum number of change events returned in a single request. Use a number to limit the size. |
pagination_offset | string | Optional | String used to specify the starting point for the next page of results. Useful for pagination. |
start_time | string | Optional | The starting timestamp for retrieving change events. Format is ISO 8601 (e.g., '2023-10-05T12:00:00Z'). |
Requirements
Output
json— Response from the API endpoint 'change-events'.AirtableApi.GetAirtableUserInfo
Fetch user details from Airtable by ID or email. Use this tool to retrieve basic information for internal or external Airtable users based on their ID or email address.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
enterprise_account_id | string | Required | The ID of the enterprise account associated with the user. Used to target specific enterprise-level user data. |
include_fields | array<string> | Optional | Specify fields to include in the response. Provide an array of field names (strings). |
user_emails | array<string> | Optional | An array of user email addresses to fetch information for. Provide one or more email strings. |
user_ids | array<string> | Optional | A list of user IDs to fetch details for. Each ID should be a string. |
Requirements
Output
json— Response from the API endpoint 'get-users-by-id-or-email'.AirtableApi.GetAirtableViewMetadata
Get basic information about an Airtable base view. Use this tool to obtain metadata for a specific view within an Airtable base, including details like name and structure. Ideal for retrieving details necessary to understand the view's configuration.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
base_identifier | string | Required | The unique ID of the Airtable base. This is required to retrieve view metadata. |
view_identifier | string | Required | A unique identifier for the Airtable view. Used to specify which view's metadata to retrieve. |
include_fields | array<string> | Optional | Array of field names to include in the view metadata response. Specify specific fields if required. |
Requirements
Output
json— Response from the API endpoint 'get-view-metadata'.AirtableApi.GetAuditLogEvents
Retrieve audit log events for an enterprise. Use this tool to get audit log events related to an enterprise account. It provides access to historical and ongoing log data to track activities and changes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
enterprise_account_id | string | Required | The unique identifier for the enterprise account to retrieve audit log events for. |
end_time | string | Optional | The end time for retrieving audit log events. The format is ISO 8601 (e.g., '2023-10-15T10:00:00Z'). |
event_category | string | Optional | Filter audit log events by specific categories. Accepts string values like 'security', 'compliance', etc. |
event_type | string | Optional | Specify the type of event to filter the audit logs. Use a string representing the event category. |
filter_by_originating_user_id | string | Optional | Filter audit log events by the ID of the originating user. |
model_identifier | string | Optional | A string that specifies the model ID related to the audit log event. |
next_page_token | string | Optional | Token to retrieve the next page of results when paginating through a large set of audit log events. |
page_size | number | Optional | Number of log events to retrieve per page. It determines the size of the data fetched in a single API call. |
previous_event_marker | string | Optional | A string marker to paginate backwards through audit log events, indicating the last event seen. |
sort_order | string | Optional | Defines the order in which results are sorted. Use 'ascending' or 'descending'. |
start_time | string | Optional | Specify the starting point for retrieving audit logs. Use ISO 8601 format (e.g., '2023-01-01T00:00:00Z'). |
Requirements
Output
json— Response from the API endpoint 'audit-log-events'.AirtableApi.GetBaseCollaborators
Retrieve information on base collaborators. Fetches details about active collaborators and outstanding invites for a specified Airtable base, excluding deleted users.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
base_id | string | Required | The unique identifier of the Airtable base to fetch collaborators from. This is a required string value. |
fields_to_include | array<string> | Optional | A list of fields to include in the response. Specify as an array of strings such as ['email', 'name']. |
Requirements
Output
json— Response from the API endpoint 'get-base-collaborators'.AirtableApi.GetEdiscoveryExportsStatus
Retrieve status and results of all eDiscovery exports. Use this tool to get the current status and results for all eDiscovery exports within an enterprise account.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
enterprise_account_id | string | Required | The ID of the enterprise account for which to retrieve eDiscovery export status and results. |
ediscovery_export_state | string | Optional | Filter exports by state: 'pending', 'processing', 'error', or 'done'. |
pagination_offset | number | Optional | The number of records to skip for pagination. Useful for accessing data beyond initial pages. |
result_page_size | number | Optional | Specify the number of eDiscovery export results to return per page. |
Requirements
Output
json— Response from the API endpoint 'list-ediscovery-export'.AirtableApi.GetEdiscoveryExportStatus
Retrieve the status and result of an eDiscovery export. Use this tool to check the status and obtain results of an eDiscovery export for a specific enterprise account.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
enterprise_account_id | string | Required | The ID of the enterprise account for which to retrieve the eDiscovery export status and results. |
enterprise_task_id | string | Required | The unique identifier for the eDiscovery export task. Required to check the status and get results. |
Requirements
Output
json— Response from the API endpoint 'get-ediscovery-export'.AirtableApi.GetEnterpriseInfo
Retrieve basic information about an enterprise account. This tool returns fundamental details regarding a specified enterprise account, which can be useful for understanding account characteristics and status.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
enterprise_account_id | string | Required | The unique identifier for the target enterprise account. This is required to fetch the relevant account information. |
fields_to_include | array<string> | Optional | Specify an array of field names as strings to include in the response. Leaving this empty includes all default fields. |
Requirements
Output
json— Response from the API endpoint 'get-enterprise'.AirtableApi.GetInterfaceInfo
Retrieve information about a specified interface. This tool fetches general details about a specified Airtable interface, excluding any deleted collaborators and including only outstanding invites. Use it when you need to access interface information via the interface ID (`pageBundleId`).
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
airtable_base_id | string | Required | The unique identifier of the Airtable base. This ID specifies which base the interface information belongs to. |
interface_id | string | Required | The ID of the Airtable interface to retrieve information for. This is found in the `interfaces` object from the `get base collaborators` endpoint. |
include_elements | array<string> | Optional | Specify elements to include in the response. Provide as an array of strings representing the element names or IDs. |
Requirements
Output
json— Response from the API endpoint 'get-interface'.AirtableApi.GetRecordComments
Retrieve comments for a specific record in Airtable. Use this tool to get a list of comments for a record in Airtable, ordered from newest to oldest. This can be useful for tracking discussions or updates related to a specific record.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
base_id | string | Required | The unique identifier for the Airtable base containing the record. |
record_id | string | Required | Unique identifier for the record in Airtable whose comments are to be retrieved. |
table_identifier | string | Required | The unique ID or name of the table containing the record. Specify either the ID or name to locate the table. |
pagination_offset | string | Optional | A string used for pagination to fetch the next set of comments. Generally returned from a previous API call. |
results_page_size | number | Optional | Number of comments to return per page. Useful for pagination. |
Requirements
Output
json— Response from the API endpoint 'list-comments'.AirtableApi.GetScimUser
Get details of a single SCIM User by userId. Use this tool to retrieve information about a specific user as a SCIM User object, using their unique userId.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
user_id | string | Required | The unique identifier of the SCIM User to retrieve details for. |
Requirements
Output
json— Response from the API endpoint 'get-scim-user'.AirtableApi.GetUserGroupInfo
Retrieve basic information about a specific user group. Use this tool to obtain key details for a specific user group by providing the group ID. It is useful when you need to display or process user group information.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
user_group_id | string | Required | Provide the identifier for the user group to retrieve its basic information. |
include_additional_info | array<string> | Optional | An array of strings specifying additional data to be included in the response, such as 'members' or 'permissions'. |
Requirements
Output
json— Response from the API endpoint 'get-user-group'.AirtableApi.GetUserInformation
Fetch user information by ID from Airtable Enterprise. Use this tool to retrieve basic information for an internal or external user in an Airtable Enterprise account by providing the user's ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
enterprise_account_id | string | Required | The ID of the Airtable Enterprise account associated with the user. This is required to fetch user data. |
user_id | string | Required | The unique identifier for the user whose information is to be retrieved. Provide the user ID as a string. |
include_fields | array<string> | Optional | Specify the list of fields to include in the user information response. Provide as an array of field names. |
Requirements
Output
json— Response from the API endpoint 'get-user-by-id'.AirtableApi.GetWorkspaceCollaborators
Retrieve information about workspace collaborators and invites. This tool retrieves basic information about collaborators in a specific workspace, excluding deleted collaborators and including only outstanding invites. Useful for managing or reviewing current workspace memberships and pending invitations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
workspace_identifier | string | Required | The unique identifier of the workspace to retrieve collaborators and outstanding invites for. Provide the ID as a string. |
include_additional_information | array<string> | Optional | List of additional fields to include in the response. Specify field names as strings, like 'email' or 'role'. |
Requirements
Output
json— Response from the API endpoint 'get-workspace-collaborators'.AirtableApi.GrantAdminAccess
Grant admin access to specified users. This tool grants admin access to users via their ID or email. It should be called when an admin needs to grant elevated privileges to users on an enterprise account. If both ID and email are provided, email is ignored. The result includes successful grants and any errors encountered. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
enterprise_account_id | string | Optional | The ID of the enterprise account to which admin access will be granted. Required for processing the request. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'grant-admin-access'.AirtableApi.ListAirtableBases
Retrieve a list of accessible Airtable bases. Use this tool to obtain a list of Airtable bases that the token has access to. The tool returns up to 1000 bases at a time, along with pagination information if more results are available.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pagination_offset | string | Optional | A string token to fetch the next set of Airtable bases if more results are available. Use the token from the last response to continue pagination. |
Requirements
Output
json— Response from the API endpoint 'list-bases'.AirtableApi.ListAirtableBaseViews
Retrieve information on Airtable base views. This tool is used to obtain basic information about the views within a specified Airtable base. It should be called when you need details about the different views available in a particular base in Airtable.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
airtable_base_id | string | Required | The ID of the Airtable base for which you want to list views. |
fields_to_include | array<string> | Optional | A list of specific fields to include in the response. It filters the fields returned for each view. |
Requirements
Output
json— Response from the API endpoint 'list-views'.AirtableApi.ListAirtableRecords
Retrieve records from a specified Airtable table. This tool retrieves records from a specified table in Airtable, supporting pagination and filtering options. Use table IDs to avoid modifying requests when table names change. Supports offset for pagination and maxRecords to limit the results.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
base_id | string | Required | The unique identifier for the Airtable base where the table is located. |
table_id_or_name | string | Required | The ID or name of the Airtable table to retrieve records from. Using table IDs is recommended for consistency. |
cell_format_method | string | Optional | Defines how cell values are returned. Specify 'json' for unformatted or 'string' for formatted values. |
filter_by_formula | string | Optional | A formula string to filter records. Use Airtable's formula syntax where functions and operators will be applied to fields. |
maximum_records | number | Optional | Specify the maximum number of records to retrieve from the Airtable table. |
output_time_zone | string | Optional | Specifies the time zone for datetimes returned in records. Use IANA time zone format (e.g., 'America/Los_Angeles'). |
page_size | number | Optional | Number of records per page to fetch. Default is 100. |
pagination_offset | string | Optional | A string used for pagination to fetch the next set of records. Use the offset provided in the previous response to continue retrieving records. |
record_metadata_fields | array<string> | Optional | An array of strings specifying which metadata fields to include for each record. |
return_fields_by_field_id | boolean | Optional | Return fields by their field ID instead of field name when set to true. |
sort_order | string | Optional | Specifies the order of records. Use a JSON string with fields and directions (asc or desc). |
specific_fields | string | Optional | Comma-separated list of field names to be included in the response. If omitted, all fields are returned. |
specified_view | string | Optional | Specifies the view in the table to be used for record retrieval. Provide the name or ID of the view. |
user_locale | string | Optional | Specify the user locale to determine the language and regional settings for the records. |
Requirements
Output
json— Response from the API endpoint 'list-records'.AirtableApi.ListBaseBlockInstallations
Retrieve basic info of block installations for a specific base. Use this tool to get a list of block installations within a specified base in Airtable. It provides basic information about each block installation, useful for managing and understanding block deployments in a base.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
base_id | string | Required | The unique identifier for a specific Airtable base to retrieve block installations from. |
Requirements
Output
json— Response from the API endpoint 'list-block-installations'.AirtableApi.ListScimGroups
Retrieve a list of SCIM groups from Airtable. This tool calls Airtable's API to retrieve a list of groups formatted as SCIM Group objects. It should be used when you need to obtain detailed group information in compliance with the SCIM specification.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
filter_criteria | string | Optional | Defines a string-based filter to query specific SCIM groups in Airtable. Use SCIM filtering syntax to specify criteria. |
group_count | number | Optional | Specify the maximum number of SCIM groups to list. It is an integer that determines how many groups the API should return. |
Requirements
Output
json— Response from the API endpoint 'list-scim-groups'.AirtableApi.ListScimUsers
Retrieve a list of SCIM users from Airtable. Use this tool to get a list of users represented as SCIM User objects, following the SCIM specification for list responses.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
start_index | number | Optional | The starting index for the list of SCIM users to retrieve. Use a positive integer to specify where to start listing from. |
user_count_limit | number | Optional | The maximum number of SCIM user objects to return in the response. This should be a positive integer. |
user_filter | string | Optional | Apply a filter string to narrow down the list of SCIM users. Uses SCIM standard filtering syntax. |
Requirements
Output
json— Response from the API endpoint 'list-scim-users'.AirtableApi.ListWebhookPayloads
Retrieve update messages for a specified Airtable webhook. This tool retrieves the update messages that a client can consume for a specific webhook. It should be called after a webhook ping is received. Using this tool will also extend the webhook's expiration by setting it to 7 days from the call.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
base_id | string | Required | Identifier for the Airtable base from which to list webhook payloads. |
webhook_id | string | Required | The unique identifier for the webhook to retrieve update messages. This should be a string and should match the webhook set up in Airtable. |
maximum_number_of_messages | number | Optional | The maximum number of update messages to retrieve for the webhook. |
pagination_cursor | number | Optional | A numerical position indicating where to begin retrieving messages from the webhook payload list. Use this for pagination to continue from a previous list retrieval. |
Requirements
Output
json— Response from the API endpoint 'list-webhook-payloads'.AirtableApi.ListWebhooksForBase
Retrieve registered webhooks and their statuses for a base. Use this tool to list all webhooks registered for a specific base, including their statuses. Requires read-level permissions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
base_identifier | string | Required | The unique identifier for the base whose webhooks you want to list. |
Requirements
Output
json— Response from the API endpoint 'list-webhooks'.AirtableApi.LogoutUserEnterpriseAccount
Logs out an enterprise account user. This tool logs out a user from an enterprise account. Applicable for ELA and FLA internal enterprise account users and managed claiming enterprise users.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
enterprise_account_id | string | Required | The unique identifier for the enterprise account. Required for logging out a user from the account. |
user_id | string | Required | The unique identifier of the user to log out from the enterprise account. |
Requirements
Output
json— Response from the API endpoint 'logout-user'.AirtableApi.ManageAirtableBlockInstallation
Manages the installation state of an Airtable block. This tool modifies the installation state of a specified block in a given Airtable base. It should be called when there is a need to update the status or settings of a block installation. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
airtable_base_id | string | Optional | The unique identifier for the Airtable base where the block is installed. It is required to specify the base for the block installation. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
block_installation_id | string | Optional | The unique identifier for the block installation to be managed. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'manage-block-installation'.AirtableApi.ManageAirtableSharing
Update and manage the share state of an Airtable base. Use this tool to modify the sharing configuration for a specific Airtable base. It's useful for changing user access or permissions associated with the base. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
airtable_base_id | string | Optional | The unique identifier for the Airtable base to manage its share state. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
share_identifier | string | Optional | The unique identifier for the share configuration to modify in Airtable. It specifies which share state needs to be managed. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'manage-share'.AirtableApi.ManageEnterpriseAccountUser
Manage users in enterprise accounts. Use this tool to update details of users within an enterprise account. It is suitable for modifying user information associated with managed users.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
enterprise_account_id | string | Required | The unique identifier for the enterprise account. Required to manage users within the account. |
user_id | string | Required | The unique identifier for the user to be managed within the enterprise account. |
update_user_email | string | Optional | New email for the user. Ensure enterprise account owns both original and destination domains. Follow SSO steps if applicable. |
user_first_name | string | Optional | The new first name of the user in the enterprise account. |
user_last_name | string | Optional | The last name of the user to be updated in the enterprise account. |
user_state | string | Optional | Specify the user's state as 'provisioned' or 'deactivated'. Only applicable for managed users. |
Requirements
Output
json— Response from the API endpoint 'manage-user'.AirtableApi.ModifyAirtableEntry
Update a specific record in an Airtable table. This tool updates a single record in an Airtable table. Only specified fields are updated, leaving others unchanged. Use table IDs to avoid modifying requests when table names change. Automatic data conversion can be enabled with the typecast parameter for better integration with third-party data sources. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
base_id | string | Optional | The unique identifier for the Airtable base. This specifies which base the record belongs to. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
table_identifier | string | Optional | The unique identifier or name of the Airtable table where the record resides. Prefer using table IDs to avoid changes when table names are updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
record_identifier | string | Optional | Unique identifier for the Airtable record to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'update-record-put'.AirtableApi.MoveAirtableBase
Move a base between Airtable workspaces. Use this tool to move a base from one workspace to another within the same Airtable enterprise account. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
target_workspace_id | string | Optional | The ID of the target workspace where the base will be moved. It should be a valid string ID of an existing workspace within the same Airtable enterprise. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'move-base'.AirtableApi.MoveWorkspacesBetweenEnterpriseAccounts
Move workspaces between enterprise accounts within the same organization. Use this tool to batch move workspaces from one enterprise account to another within the same organization, provided the Enterprise Hub feature is enabled. Note that non-org unit collaborators might be removed if the target account's invite settings are restricted. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
enterprise_account_id | string | Optional | The unique identifier of the enterprise account to which workspaces are being moved. Ensure it belongs to the same organization. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'move-workspaces'.AirtableApi.ReadHyperdbTableRecords
Retrieve records from a specified HyperDB table. Use this tool to fetch records from a HyperDB table by specifying the enterprise account ID and data table ID. Ideal for accessing or reviewing data stored in HyperDB tables.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
data_table_id | string | Required | The identifier of the HyperDB table from which records are to be retrieved. It is required to specify the correct table ID to access the corresponding data. |
enterprise_account_id | string | Required | The unique identifier for the enterprise account. Required to access records from the specified HyperDB table. |
fields_to_retrieve | array<string> | Optional | List of field names to retrieve from the HyperDB table records. Specify as an array of strings. |
maximum_records_to_retrieve | number | Optional | The maximum number of records to retrieve from the HyperDB table. Specify an integer value to limit the number of records returned. |
pagination_cursor | string | Optional | A string representing the position within the dataset to start retrieving records from. Use for paginated data retrieval. |
primary_keys_to_retrieve | array<string> | Optional | An array of primary key strings to specify which records to retrieve from the HyperDB table. |
Requirements
Output
json— Response from the API endpoint 'hyperdb-table-read-records'.AirtableApi.RemoveBaseCollaborator
Remove a collaborator from a base. Use this tool to delete a collaborator from a specific base in Airtable. It should be called when you want to remove access for a user or group to a base.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
base_id | string | Required | The unique identifier for the base from which the collaborator will be removed. This is a required field. |
collaborator_id | string | Required | The unique identifier for the user or group to be removed from the base. |
Requirements
Output
json— Response from the API endpoint 'delete-base-collaborator'.AirtableApi.RemoveInterfaceCollaborator
Remove a collaborator from an interface. Use this tool to delete an interface collaborator. Base collaborator access is needed to remove others, but it can also be used for self-removal with interface-only access.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
base_id | string | Required | The unique identifier for the Airtable base. This is required to specify which base the collaborator will be removed from. |
collaborator_id | string | Required | The ID of the user or group to be removed as an interface collaborator. Must be a valid identifier. |
interface_page_bundle_id | string | Required | The ID of the page bundle within the interface from which the collaborator is being removed. |
Requirements
Output
json— Response from the API endpoint 'delete-interface-collaborator'.AirtableApi.RemoveUserFromEnterprise
Unshare a user from all enterprise assets and revoke admin access. This tool removes a user's access from all enterprise workspaces, bases, interfaces, and user groups. It also revokes admin access if applicable. It returns lists detailing the unsharing and sharing actions that were executed. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
enterprise_account_id | string | Optional | The ID of the enterprise account from which the user will be removed. Required to specify the enterprise context for user unsharing. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
user_id | string | Optional | The unique identifier of the user to be removed from the enterprise. It is a required string value. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'remove-user-from-enterprise'.AirtableApi.RemoveWorkspaceCollaborator
Remove a collaborator from an Airtable workspace. Use this tool to remove a collaborator, identified by user or group ID, from a specified Airtable workspace.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
collaborator_identifier | string | Required | The ID of the user or group to be removed from the workspace. |
workspace_id | string | Required | The unique identifier of the Airtable workspace from which to remove a collaborator. |
Requirements
Output
json— Response from the API endpoint 'delete-workspace-collaborator'.AirtableApi.RetrieveAuditLog
Retrieve a specific audit log request. Fetches details of a specified audit log request using the enterprise account and audit log task IDs. This tool is not recommended for new use cases; consider using the audit log events API instead.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
audit_log_task_id | string | Required | The unique identifier for the specific audit log task to retrieve. This is required to fetch the log details. |
enterprise_account_id | string | Required | The unique identifier for the enterprise account. This ID is required to retrieve the specific audit log request. |
Requirements
Output
json— Response from the API endpoint 'get-audit-log-request'.AirtableApi.RetrieveAuditLogRequests
Retrieve all audit log requests for an enterprise account. This tool retrieves all the audit log requests for a given enterprise account. It's meant for accessing historical log records. Note that using this API is discouraged for new use cases; consider using the audit log events API instead.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
enterprise_account_id | string | Required | The unique identifier for the enterprise account to retrieve audit log requests for. |
audit_log_page_size | number | Optional | Specify the number of audit log requests to return per page. Use this to control pagination. |
pagination_offset | number | Optional | A number indicating the starting point for retrieving audit log requests. Used for pagination. |
Requirements
Output
json— Response from the API endpoint 'list-audit-log-requests'.AirtableApi.RetrieveUserIdAndScopes
Retrieve user's ID, associated scopes, and email if available. This tool retrieves the user's ID and the associated scopes with the OAuth token used. If the token has the `user.email:read` scope, the tool also returns the user's email.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'get-user-id-scopes'.AirtableApi.RevokeAdminAccess
Revoke admin access from specified users. Use this tool to revoke admin access from users by providing either their user ID or email. Only directly assigned admin access can be revoked. If both ID and email are provided, only the ID is used. Errors for unprocessed users are included in the response. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
enterprise_account_id | string | Optional | The unique identifier for the enterprise account. Required to target the specific account for admin access revocation. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'revoke-admin-access'.AirtableApi.ToggleWebhookNotifications
Enable or disable webhook notification pings. Use this tool to enable or disable notification pings for a specific webhook in Airtable. Requires creator-level permissions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
airtable_base_id | string | Optional | The unique identifier for the Airtable base. This specifies which database to target for enabling or disabling webhook notifications. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
webhook_id | string | Optional | The unique identifier for the webhook to be modified. Required for specifying which webhook's notifications you want to enable or disable. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'enable-disable-webhook-notifications'.AirtableApi.UpdateAirtableFieldDetails
Updates the name or description of an Airtable field. This tool updates the name and/or description of a specified field in an Airtable base. It requires at least one of the name or description to be provided. Use this when you need to change field metadata in Airtable.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
airtable_base_id | string | Required | The unique ID of the Airtable base containing the field to update. |
airtable_table_id | string | Required | The ID of the table in which the field's metadata is to be updated. |
field_column_id | string | Required | The unique identifier for the field (column) to be updated in the Airtable base. |
new_field_description | string | Optional | The new description for the field. Optional, max 20,000 characters. |
new_field_name | string | Optional | The new name for the field in Airtable. This is optional but must be provided if no new description is given. |
Requirements
Output
json— Response from the API endpoint 'update-field'.AirtableApi.UpdateAirtableRecord
Update a single Airtable record with specified fields. This tool updates a single record in Airtable using either table names or IDs. Use it when you need to modify specific fields of a record without altering the rest. Supports automatic data conversion with the typecast parameter. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
base_id | string | Optional | The unique identifier of the Airtable base where the record exists. This ID is required to specify which base to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
table_id_or_name | string | Optional | The identifier or name of the Airtable table where the record resides. Using table IDs is recommended for stability. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
airtable_record_id | string | Optional | The unique identifier for the Airtable record you want to update. It is required to specify which record to modify. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'update-record'.AirtableApi.UpdateAirtableRecords
Update or upsert multiple records in an Airtable table. Use this tool to update up to 10 records in an Airtable table, or to upsert them by setting the `performUpsert` option. The tool is ideal when you want to make changes to specific fields without affecting others. By default, only included fields are updated. Use `PUT` instead of `PATCH` for destructive updates, which clear unincluded fields. Upserts enable the creation of new records if no match is found or update them if a match is found. Typecasting can be enabled to convert strings to appropriate cell values. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
airtable_base_id | string | Optional | The unique identifier for the Airtable base where the records will be updated or upserted. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
airtable_table_id_or_name | string | Optional | The ID or name of the Airtable table where records will be updated or upserted. Using the table ID is recommended for less disruption if the table name changes. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'update-multiple-records'.AirtableApi.UpdateAirtableTable
Update the properties of an Airtable table. Use this tool to update the name, description, or date dependency settings of a specific Airtable table identified by its base ID and table ID or name. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
airtable_base_id | string | Optional | The unique identifier for the Airtable base containing the table to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
table_id_or_name | string | Optional | The identifier or name of the table to update in Airtable. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'update-table'.AirtableApi.UpdateCollaboratorPermission
Update a collaborator's permission level on a base. Use this tool to modify the permission level of a specific collaborator on a designated base. Ideal for managing user access and ensuring appropriate permissions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
base_identifier | string | Optional | The unique identifier for the base to update permission. Required as a string. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
collaborator_id | string | Optional | The unique identifier for the user or group whose permission level is being updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'update-collaborator-base-permission'.AirtableApi.UpdateCollaboratorPermissions
Update permissions for an interface-only collaborator. This tool updates the permissions for a specific collaborator associated with an interface in Airtable. Use it to modify access levels for collaborators on a specific base and interface. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
base_identifier | string | Optional | The unique identifier for the Airtable base where the collaborator's permissions are being updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
interface_page_bundle_id | string | Optional | The unique identifier for the page bundle associated with the interface in Airtable. Required to specify which interface the permissions are being updated for. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
collaborator_id | string | Optional | The unique ID of the user or group whose permissions are to be updated. This is required for specifying which collaborator's access level should be modified. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'update-interface-collaborator'.AirtableApi.UpdateGroupAttributes
Replace a group's attributes with new values. Use this tool to update all attributes of a specified group with new values in Airtable. Call this when a complete group update is necessary. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
group_id | string | Optional | The unique identifier for the group whose attributes need to be replaced. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'put-scim-group'.AirtableApi.UpdateGroupDetails
Update group details using SCIM patch operations. This tool allows you to apply a series of SCIM patch operations to update a group's details on Airtable. It applies the operations sequentially, following the SCIM specification. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
group_id | string | Optional | A string representing the unique identifier of the group to be updated using SCIM patch operations. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patch-scim-group'.AirtableApi.UpdateRecordComment
Update a comment on a specific record. Use this tool to update a comment you've created on a specific record in Airtable. Ensure the comment belongs to you before attempting to update. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
base_identifier | string | Optional | The unique identifier for the Airtable base containing the record. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
table_id_or_name | string | Optional | The ID or name of the Airtable table where the record with the comment is located. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
record_id | string | Optional | The unique identifier of the record whose comment you want to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
comment_id | string | Optional | The unique identifier of the comment to update. Ensure it belongs to the authorized user. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'update-comment'.AirtableApi.UpdateScimUserRecord
Apply SCIM patch operations to update user details. Use this tool to perform a sequence of SCIM patch operations on an existing user. Suitable for updating user attributes according to SCIM specification. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
user_id | string | Optional | The unique identifier for the user to be updated. It should match the user's existing SCIM record. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patch-scim-user'.AirtableApi.UpdateUserAttributes
Replace a user's attributes with new values. Use this tool to update all attributes for a specific user in the SCIM system. It allows setting the 'active' status to true or false, and requires full replacement of existing attributes. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
user_id | string | Optional | The unique identifier of the user whose attributes are to be replaced. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'put-scim-user'.AirtableApi.UpdateWorkspaceCollaboratorPermission
Modify a collaborator's permission level in a workspace. Use this tool to update the permission level of a collaborator within a specified workspace, adjusting their access rights as needed. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
workspace_id | string | Optional | The unique identifier of the workspace where the collaborator's permissions will be updated. This is required to specify which workspace is being modified. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
collaborator_id | string | Optional | The identifier for the user or group whose permissions are being updated in the workspace. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'update-workspace-collaborator'.AirtableApi.UpdateWorkspaceRestrictions
Updates sharing restrictions for an Airtable workspace. Use this tool to modify the sharing restrictions settings of a specific Airtable workspace by providing the workspace ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
workspace_id | string | Required | The unique identifier for the Airtable workspace to update restrictions. |
invite_creation_restriction | string | Optional | Defines who can create invites in the workspace. Choose between 'unrestricted' or 'onlyOwners'. |
share_creation_restriction | string | Optional | Specify the sharing creation restriction. Choose between 'unrestricted' or 'onlyOwners'. |
Requirements
Output
json— Response from the API endpoint 'update-workspace-restrictions'.AirtableApi.UploadAttachmentToAirtable
Upload attachments to an Airtable record's cell. Use this tool to upload an attachment directly into a specified record and cell in Airtable, with a file size limit of 5 MB. For larger files, consider using a public URL method. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
airtable_base_id | string | Optional | The unique identifier of the Airtable base where the attachment will be uploaded. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
airtable_record_id | string | Optional | The unique string identifier for the Airtable record to which the attachment will be uploaded. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
attachment_field_id_or_name | string | Optional | The ID or name of the field where the attachment will be uploaded. This specifies the target field in the Airtable record. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'upload-attachment'.AirtableApi.UpsertAirtableRecords
Update or insert records in an Airtable HyperDB table. Use this tool to update or insert records in an Airtable HyperDB table by matching primary keys. Ideal for syncing data or ensuring records are up-to-date without manual oversight. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
enterprise_account_id | string | Optional | The identifier for the Airtable enterprise account. Required for accessing the HyperDB table. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
data_table_id | string | Optional | The identifier for the HyperDB data table in Airtable. Required for targeting the specific table for upsert operations. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'hyperdb-upsert-records-by-primary-keys'.