Server path:Documentation Index
Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
Use this file to discover all available pages before exploring further.
/airtable | Type: Application | PCID required: Yes
Tools
airtable_add_base_collaborator
Add base collaborator Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
baseId | string | Yes | — | Base Id |
collaborators | any[] | Yes | — | This endpoint accepts two types of collaborators: individual user and group. |
airtable_add_interface_collaborator
Add interface collaborator Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
baseId | string | Yes | — | Base Id |
pageBundleId | string | Yes | — | Page Bundle Id |
collaborators | any[] | Yes | — | This endpoint accepts two types of collaborators: individual user and group. This route currently supports adding only one collaborator at a time. |
airtable_add_workspace_collaborator
Add workspace collaborator Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Workspace Id |
collaborators | any[] | Yes | — | This endpoint accepts two types of collaborators: individual user and group. |
airtable_audit_log_events
Audit log events Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
enterpriseAccountId | string | Yes | — | Enterprise Account Id |
startTime | string | No | — | Earliest audit log event to retrieve (inclusive), in ISO 8601 date time format. Optional. Defaults to the beginning of the retention period, 180 days ago. |
endTime | string | No | — | Latest audit log event to retrieve (exclusive), in ISO 8601 date time format. Optional. Defaults to now. |
originatingUserId | string[] | No | — | Retrieve audit log events originating from the provided user ID or IDs (maximum 100). Optional. |
eventType | string[] | No | — | Retrieve audit log events falling under the provided event type or event types (maximum 100). Optional. |
modelId | string[] | No | — | Retrieve audit log events taking action on, or involving, the provided model ID or IDs (maximum 100). Optional. |
pageSize | number | No | — | The number of events per page. Maximum value of 1000; defaults to 10. |
sortOrder | string | No | — | Sort the events by timestamp in ascending or descending order. Defaults to descending. |
previous | string | No | — | If there are older items to retrieve, a previous is returned. Pass the previous from a prior call to retrieve the next-oldest page of items. You may pass the special value null to indicate “use the default behavior”, which operates identically to omitting the previous parameter entirely. |
next | string | No | — | If there are newer items to retrieve, a next is returned. Pass the next from a prior call to retrieve the next-newest page of items. You may pass the special value null to indicate “use the default behavior”, which operates identically to omitting the next parameter entirely. |
category | string[] | No | — | The category value |
airtable_change_events
Change events Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
enterpriseAccountId | string | Yes | — | Enterprise Account Id |
startTime | string | No | — | Earliest change event to retrieve (inclusive), in ISO 8601 date time format. Optional. |
endTime | string | No | — | Latest change event to retrieve (exclusive), in ISO 8601 date time format. Optional. |
pageSize | number | No | — | The number of records per page. Maximum value of 100; defaults to 10. |
offset | string | No | — | If there may be more to retrieve, an offset is returned. Pass the offset to the next call to retrieve the next page. Do not pass offset when retrieving the first page. |
airtable_create_a_webhook
Create a webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
baseId | string | Yes | — | Base Id |
notificationUrl | string | No | — | An optional url that can receive notification pings. See notification delivery. |
specification | object | Yes | — | A JSON object that describe the types of changes the webhook is interested in. |
airtable_create_audit_log_request
Create audit log request Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
enterpriseAccountId | string | Yes | — | Enterprise Account Id |
filter | string | No | — | An optional filter may be supplied. The filter value may be any of: - User ID - Workspace ID - Base ID - Table ID - IPv4 address (1.2.3.4) |
timePeriod | string | Yes | — | The time period (specific month or day) for which you want to retrieve audit logs for. Must be in either YYYY-MM or YYYY-MM-DD format and within the last 180 days. |
airtable_create_base
Create base Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | The name for the new base. |
tables | object[] | Yes | — | A list of JSON objects representing the tables that will be created along with the base. |
workspaceId | string | Yes | — | The workspace where the base will be created. |
airtable_create_base_from_package_enterprise
Create base from package Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
enterpriseAccountId | string | Yes | — | Enterprise Account Id |
packageId | string | Yes | — | Package Id |
description | string | No | — | Optional description for the base. |
name | string | Yes | — | The name for the new base. |
packageReleaseId | string | Yes | — | The package release ID to install. |
workspaceId | string | Yes | — | The workspace where the base will be created. |
airtable_create_comment
Create comment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
baseId | string | Yes | — | Base Id |
tableIdOrName | string | Yes | — | Table Id Or Name |
recordId | string | Yes | — | Record Id |
parentCommentId | string | No | — | A comment ID |
text | string | Yes | — | The text value |
airtable_create_descendant_enterprise
Create descendant enterprise Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
enterpriseAccountId | string | Yes | — | Enterprise Account Id |
name | string | Yes | — | The name value |
airtable_create_ediscovery_export
Create eDiscovery export Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
enterpriseAccountId | string | Yes | — | Enterprise Account Id |
baseId | string | Yes | — | Base ID to create eDiscovery export for. |
includeCsvFormat | boolean | No | — | If set, also export the base as CSVs (in a zipped file). Once the export is ready for download, the URL to the zip file will be available in the csvZipDownloadUrl attribute. |
shouldSendEmailOnCompletion | boolean | No | — | If set, an email will be sent to the user who initiated the export once the export is ready for download. |
airtable_create_field
Create field Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
baseId | string | Yes | — | Base Id |
tableId | string | Yes | — | Table Id |
body | object | No | — | This identical to Field type and options, with an additional name and description property on all types |
airtable_create_records
Create records Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
baseId | string | Yes | — | Base Id |
tableIdOrName | string | Yes | — | Table Id Or Name |
fields | object | No | — | Create a single record |
records | object[] | No | — | Create multiple records Pass in multiple records to create multiple in one request |
returnFieldsByFieldId | boolean | No | — | An optional boolean value that lets you return field objects keyed by the field id. This defaults to false, which returns field objects where the key is the field name. |
typecast | boolean | No | — | The Airtable API will perform best-effort automatic data conversion from string values if the typecast parameter is passed in. Automatic conversion is disabled by default to ensure data integrity, but it may be helpful for integrating with 3rd party data sources. |
airtable_create_table
Create table Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
baseId | string | Yes | — | Base Id |
description | string | No | — | The description for the table (optional). If present, must be a non-empty string no longer than 20,000 characters. |
fields | any[] | Yes | — | A list of JSON objects representing the fields in the table. Refer to field types for supported field types, the write format for field options, and other specifics for certain field types. |
name | string | Yes | — | The name for the table. |
airtable_create_workspace
Create workspace Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
enterpriseAccountId | string | Yes | — | The enterprise account that the workspace will be created in. |
name | string | Yes | — | Name of the workspace to be created. |
airtable_delete_a_webhook
Delete a webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
baseId | string | Yes | — | Base Id |
webhookId | string | Yes | — | Webhook Id |
airtable_delete_base
Delete base Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
baseId | string | Yes | — | Base Id |
airtable_delete_base_collaborator
Delete base collaborator Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
baseId | string | Yes | — | Base Id |
userOrGroupId | string | Yes | — | User Or Group Id |
airtable_delete_base_invite
Delete base invite Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
baseId | string | Yes | — | Base Id |
inviteId | string | Yes | — | Invite Id |
airtable_delete_block_installation
Delete block installation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
baseId | string | Yes | — | Base Id |
blockInstallationId | string | Yes | — | Block Installation Id |
airtable_delete_comment
Delete comment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
baseId | string | Yes | — | Base Id |
tableIdOrName | string | Yes | — | Table Id Or Name |
recordId | string | Yes | — | Record Id |
rowCommentId | string | Yes | — | Row Comment Id |
airtable_delete_interface_collaborator
Delete interface collaborator Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
baseId | string | Yes | — | Base Id |
pageBundleId | string | Yes | — | Page Bundle Id |
userOrGroupId | string | Yes | — | User Or Group Id |
airtable_delete_interface_invite
Delete interface invite Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
baseId | string | Yes | — | Base Id |
pageBundleId | string | Yes | — | Page Bundle Id |
inviteId | string | Yes | — | Invite Id |
airtable_delete_multiple_records
Delete multiple records Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
baseId | string | Yes | — | Base Id |
tableIdOrName | string | Yes | — | Table Id Or Name |
records | string[] | No | — | The recordIds of each record to be deleted. Up to 10 recordIds can be provided. |
airtable_delete_record
Delete record Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
baseId | string | Yes | — | Base Id |
tableIdOrName | string | Yes | — | Table Id Or Name |
recordId | string | Yes | — | Record Id |
airtable_delete_share
Delete share Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
baseId | string | Yes | — | Base Id |
shareId | string | Yes | — | Share Id |
airtable_delete_user_by_id
Delete user by id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
enterpriseAccountId | string | Yes | — | Enterprise Account Id |
userId | string | Yes | — | User Id |
airtable_delete_users_by_email
Delete users by email Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
enterpriseAccountId | string | Yes | — | Enterprise Account Id |
email | string[] | No | — | The email value |
airtable_delete_view
Delete view Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
baseId | string | Yes | — | Base Id |
viewId | string | Yes | — | View Id |
airtable_delete_workspace
Delete workspace Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Workspace Id |
airtable_delete_workspace_collaborator
Delete workspace collaborator Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Workspace Id |
userOrGroupId | string | Yes | — | User Or Group Id |
airtable_delete_workspace_invite
Delete workspace invite Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Workspace Id |
inviteId | string | Yes | — | Invite Id |
airtable_enable_disable_webhook_notifications
Enable/disable webhook notifications Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
baseId | string | Yes | — | Base Id |
webhookId | string | Yes | — | Webhook Id |
enable | boolean | Yes | — | The enable value |
airtable_get_audit_log_request
Get audit log request Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
enterpriseAccountId | string | Yes | — | Enterprise Account Id |
enterpriseAuditLogTaskId | string | Yes | — | Enterprise Audit Log Task Id |
airtable_get_base_collaborators
Get base collaborators Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
baseId | string | Yes | — | Base Id |
include | string[] | No | — | If specified, collaborators, interfaces, inviteLinks key, and/or packages will be included in the response object. Otherwise, they will be left out. |
airtable_get_base_schema
Get base schema Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
baseId | string | Yes | — | Base Id |
include | string[] | No | — | If specified, additional fields to include in the views object response; currently, this list only allows a single literal value visibleFieldIds (for views of type grid only) |
airtable_get_ediscovery_export
Get eDiscovery export Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
enterpriseAccountId | string | Yes | — | Enterprise Account Id |
enterpriseTaskId | string | Yes | — | Enterprise Task Id |
airtable_get_enterprise
Get enterprise Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
enterpriseAccountId | string | Yes | — | Enterprise Account Id |
include | string[] | No | — | If specified, aggregated and/or descendants keys will be included in the response object. Otherwise, it will be left out. |
airtable_get_interface
Get interface Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
baseId | string | Yes | — | Base Id |
pageBundleId | string | Yes | — | Page Bundle Id |
include | string[] | No | — | Related resources to include |
airtable_get_record
Get record Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
baseId | string | Yes | — | Base Id |
tableIdOrName | string | Yes | — | Table Id Or Name |
recordId | string | Yes | — | Record Id |
cellFormat | string | No | — | The format that should be used for cell values. Supported values are: - json: cells will be formatted as JSON, depending on the field type. - string: cells will be formatted as user-facing strings, regardless of the field type. The timeZone and userLocale parameters are required when using string as the cellFormat. Note: You should not rely on the format of these strings, as it is subject to change. The default is json. |
returnFieldsByFieldId | boolean | No | — | An optional boolean value that lets you return field objects where the key is the field id. This defaults to false, which returns field objects where the key is the field name. |
includeDateDependencyMetadata | boolean | No | — | An optional boolean value that returns linked record cell values as objects instead of record IDs. When true, all linked record fields return an array of objects with an id property. Linked record fields configured for date dependencies include an optional dateDependencyMetadata object with dependencyType and buffer fields (when date dependencies are configured in fixed mode). When false or unset, linked record fields return an array of record ID strings. This defaults to false. |
airtable_get_user_by_id
Get user by id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
enterpriseAccountId | string | Yes | — | Enterprise Account Id |
userId | string | Yes | — | User Id |
include | string[] | No | — | If specified, collaborations, aggregated, and/or descendants keys will be included in the response object. Otherwise, they will be left out. |
airtable_get_user_group
Get user group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
groupId | string | Yes | — | Group Id |
include | string[] | No | — | If specified, collaborations key will be included in the response object. Otherwise it will be left out. You must be a group member or enterprise admin to view this information. |
airtable_get_user_id_scopes
Get user infoairtable_get_users_by_id_or_email
Get users by id or email Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
enterpriseAccountId | string | Yes | — | Enterprise Account Id |
email | string[] | No | — | Email addresses to search by. If the request does not have any userIds, you must include at least one email address. |
id | string[] | No | — | User Ids to search by. If the request does not have any email addresses, you must include at least one userId. |
include | string[] | No | — | Allows optionally including collaborations in response. |
airtable_get_view_metadata
Get view metadata Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
baseId | string | Yes | — | Base Id |
viewId | string | Yes | — | View Id |
include | string[] | No | — | If specified, additional fields to include in the views object response; currently, this list only allows a single literal value visibleFieldIds (for views of type grid only) |
airtable_get_workspace_collaborators
Get workspace collaborators Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Workspace Id |
include | string[] | No | — | If specified, collaborators or inviteLinks key will be included in the response object. Otherwise they will be left out. |
airtable_grant_admin_access
Grant admin access Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
enterpriseAccountId | string | Yes | — | Enterprise Account Id |
users | object[] | Yes | — | The users value |
airtable_list_audit_log_requests
List audit log requests Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
enterpriseAccountId | string | Yes | — | Enterprise Account Id |
pageSize | number | No | — | The number of records per page. Maximum value of 100; defaults to 10. |
offset | number | No | — | If there may be more to retrieve, an offset is returned. Pass the offset to the next call to retrieve the next page. Do not pass offset when retrieving the first page. |
airtable_list_bases
List bases Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
offset | string | No | — | The offset value |
airtable_list_block_installations
List block installations Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
baseId | string | Yes | — | Base Id |
airtable_list_comments
List comments Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
baseId | string | Yes | — | Base Id |
tableIdOrName | string | Yes | — | Table Id Or Name |
recordId | string | Yes | — | Record Id |
pageSize | number | No | — | If specified, this will determine the number of comments to return. Must be less than or equal to 100. Default is 100. |
offset | string | No | — | A pointer to a specific comment. If specified, the returned comments will begin at the specified offset. An offset to the next set of comments will be provided by the API if the number of returned comments exceed the pageSize. |
airtable_list_ediscovery_export
List eDiscovery exports Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
enterpriseAccountId | string | Yes | — | Enterprise Account Id |
state | string | No | — | Filter for exports with the specified state. |
pageSize | number | No | — | The number of records per page. Maximum value of 100; defaults to 10. |
offset | number | No | — | If there may be more to retrieve, an offset is returned. Pass the offset to the next call to retrieve the next page. Do not pass offset when retrieving the first page. |
airtable_list_enterprise_packages
List packages Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
enterpriseAccountId | string | Yes | — | Enterprise Account Id |
shouldGetAllPackagesInGrid | boolean | No | — | If true and the enterprise account is the root enterprise account, returns all packages across the entire enterprise grid. Defaults to false. |
airtable_list_records
List records Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
baseId | string | Yes | — | Base Id |
tableIdOrName | string | Yes | — | Table Id Or Name |
timeZone | object | No | — | Timezone identifier |
userLocale | string | No | — | The user locale that should be used to format dates when using string as the cellFormat. This parameter is required when using string as the cellFormat. |
pageSize | number | No | — | The number of records returned in each request. Must be less than or equal to 100. Default is 100. |
maxRecords | number | No | — | The maximum total number of records that will be returned in your requests. If this value is larger than pageSize (which is 100 by default), you may have to load multiple pages to reach this total. |
offset | string | No | — | To fetch the next page of records, include offset from the previous request in the next request’s parameters. |
view | object | No | — | The name or ID of a view in the table. If set, only the records in that view will be returned. The records will be sorted according to the order of the view unless the sort parameter is included, which overrides that order. Fields hidden in this view will be returned in the results. To only return a subset of fields, use the fields parameter. |
sort | object[] | No | — | A list of sort objects that specifies how the records will be ordered. Each sort object must have a field key specifying the name of the field to sort on, and an optional direction key that is either “asc” or “desc”. The default direction is “asc”. The sort parameter overrides the sorting of the view specified in the view parameter. If neither the sort nor the view parameter is included, the order of records is arbitrary. |
filterByFormula | string | No | — | A formula used to filter records. The formula will be evaluated for each record, and if the result is not 0, false, "", NaN, [], or #Error! the record will be included in the response. We recommend testing your formula in the Formula field UI before using it in your API request. If combined with the view parameter, only records in that view which satisfy the formula will be returned. The formula must be encoded first before passing it as a value. You can use this tool to not only encode the formula but also create the entire url you need. Formulas can use field names, or field id’s inside of the formula. Note Airtable’s API only accepts request with a URL shorter than 16,000 characters. Encoded formulas may cause your requests to exceed this limit. To fix this issue you can instead make a POST request to /v0/{baseId}/{tableIdOrName}/listRecords while passing the parameters within the body of the request instead of the query parameters. |
cellFormat | string | No | — | The format that should be used for cell values. Supported values are: - json: cells will be formatted as JSON, depending on the field type. - string: cells will be formatted as user-facing strings, regardless of the field type. The timeZone and userLocale parameters are required when using string as the cellFormat. Note: You should not rely on the format of these strings, as it is subject to change. The default is json. |
fields | string[] | No | — | Only data for fields whose names or IDs are in this list will be included in the result. If you don’t need every field, you can use this parameter to reduce the amount of data transferred. Note Airtable’s API only accepts request with a URL shorter than 16,000 characters. Encoded formulas may cause your requests to exceed this limit. To fix this issue you can instead make a POST request to /v0/{baseId}/{tableIdOrName}/listRecords while passing the parameters within the body of the request instead of the query parameters. |
returnFieldsByFieldId | boolean | No | — | An optional boolean value that lets you return field objects where the key is the field id. This defaults to false, which returns field objects where the key is the field name. |
includeDateDependencyMetadata | boolean | No | — | An optional boolean value that returns linked record cell values as objects instead of record IDs. When true, all linked record fields return an array of objects with an id property. Linked record fields configured for date dependencies include an optional dateDependencyMetadata object with dependencyType and buffer fields (when date dependencies are configured in fixed mode). When false or unset, linked record fields return an array of record ID strings. This defaults to false. |
recordMetadata | string[] | No | — | An optional field that, if specified, includes commentCount on each record returned. |
airtable_list_shares
List shares Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
baseId | string | Yes | — | Base Id |
airtable_list_views
List views Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
baseId | string | Yes | — | Base Id |
include | string[] | No | — | If specified, additional fields to include in the views object response; currently, this list only allows a single literal value visibleFieldIds (for views of type grid only) |
airtable_list_webhook_payloads
List webhook payloads Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
baseId | string | Yes | — | Base Id |
webhookId | string | Yes | — | Webhook Id |
cursor | number | No | — | The first time this action is called, the cursor argument may be omitted from the request and will default to 1. After that, cursors should be saved between invocations of this action. When a client receives a ping, it should use the last cursor that this action returned when polling for new payloads, no matter how old that cursor value is. The cursor argument indicates the transaction number of the payload to start listing from. |
limit | number | No | — | If given the limit parameter specifies the maximum number of payloads to return in the response. A maximum of 50 payloads can be returned in a single request. A single payload can contain multiple updates. |
airtable_list_webhooks
List webhooks Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
baseId | string | Yes | — | Base Id |
airtable_logout_user
Logout user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
enterpriseAccountId | string | Yes | — | Enterprise Account Id |
userId | string | Yes | — | User Id |
airtable_manage_block_installation
Manage block installation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
baseId | string | Yes | — | Base Id |
blockInstallationId | string | Yes | — | Block Installation Id |
state | string | Yes | — | The state value |
airtable_manage_share
Manage share Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
baseId | string | Yes | — | Base Id |
shareId | string | Yes | — | Share Id |
state | string | Yes | — | When enabling a share a user is subject to sharing restrictions. These restrictions are not applicable when disabling a share. |
airtable_manage_user
Manage user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
enterpriseAccountId | string | Yes | — | Enterprise Account Id |
userId | string | Yes | — | User Id |
email | string | No | — | Enterprise account must own both the original and destination email domains. WARNING: If SSO is required for your enterprise account, you must follow these steps precisely to avoid locking the end user out of their account or creating duplicate accounts. - Use this API to update the user’s email to a new value (this effectively logs the user out) - Use your SSO provider’s (e.g. Okta’s) admin panel to update the user’s email to the new value - Tell the user to log into Airtable with the new email |
firstName | string | No | — | First Name |
lastName | string | No | — | Last Name |
state | string | No | — | provisioned | deactivated Can only change the state of managed users. |
airtable_manage_user_batched
Manage user batched Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
enterpriseAccountId | string | Yes | — | Enterprise Account Id |
users | object[] | Yes | — | The users value |
airtable_manage_user_membership
Manage user membership Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
enterpriseAccountId | string | Yes | — | Enterprise Account Id |
users | object[] | Yes | — | The users value |
airtable_move_base
Move base Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Workspace Id |
baseId | string | Yes | — | ID of the base to be moved |
targetIndex | number | No | — | The desired index for the base in the target workspace’s base order (optional). If provided, targetIndex must be a number between 0 (beginning of the list) and the number of bases in the target workspace (end of the list). If targetIndex is not provided, the base will be moved to the end of the list of bases in the target workspace. |
targetWorkspaceId | string | Yes | — | ID of the target workspace of the move. I.e. the workspace that the base will belong to once the move is complete. The target workspace must be in the same enterprise account as the source workspace. |
airtable_move_user_groups
Move user groups Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
enterpriseAccountId | string | Yes | — | Enterprise Account Id |
groupIds | string[] | Yes | — | ID of the groups to be moved. Up to 100 groupIds can be provided. |
targetEnterpriseAccountId | string | Yes | — | ID of the target enterprise account of the move. The target enterprise account must be in the same Hub-enabled organization as the source enterprise account, and you must have admin rights over the target enterprise account. |
airtable_move_workspaces
Move workspaces Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
enterpriseAccountId | string | Yes | — | Enterprise Account Id |
replacementOwnerId | string | No | — | If the target enterprise account has the invites settings restricted to org unit members, all non-member collaborators will be removed when the workspace are moved. If any workspace only has non-member owners, you must specify a replacementOwnerId to be added as the new owner of such workspaces. If no workspace has only non-member owners, replaceOwnerId is optional and will be ignored if provided. |
targetEnterpriseAccountId | string | Yes | — | ID of the target enterprise account of the move. The target enterprise account must be in the same Hub-enabled organization as the source enterprise account, and you must have admin rights over the target enterprise account. |
workspaceIds | string[] | Yes | — | ID of the workspaces to be moved. Up to 100 workspaceIds can be provided. |
airtable_post_sync_api_endpoint
Sync CSV data Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
baseId | string | Yes | — | Base Id |
tableIdOrName | string | Yes | — | Table Id Or Name |
apiEndpointSyncId | string | Yes | — | Api Endpoint Sync Id |
airtable_refresh_a_webhook
Refresh a webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
baseId | string | Yes | — | Base Id |
webhookId | string | Yes | — | Webhook Id |
airtable_remove_user_from_enterprise
Remove user from enterprise Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
enterpriseAccountId | string | Yes | — | Enterprise Account Id |
userId | string | Yes | — | User Id |
isDryRun | boolean | No | — | Is Dry Run |
removeFromDescendants | boolean | No | — | If true, removes the user from descendant enterprise accounts as well. Only enterprise accounts with the Enterprise Hub feature enabled have descendant enterprise accounts. |
replacementOwnerId | string | No | — | If the user is the sole owner of any workspaces, you must specify a replacementOwnerId to be added as the new owner of such workspaces. If the user is not the sole owner of any workspaces, replacementOwnerId is optional and will be ignored if provided. |
airtable_revoke_admin_access
Revoke admin access Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
enterpriseAccountId | string | Yes | — | Enterprise Account Id |
users | object[] | Yes | — | The users value |
airtable_update_collaborator_base_permission
Update collaborator base permission Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
baseId | string | Yes | — | Base Id |
userOrGroupId | string | Yes | — | User Or Group Id |
permissionLevel | string | Yes | — | Permission Level |
airtable_update_comment
Update comment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
baseId | string | Yes | — | Base Id |
tableIdOrName | string | Yes | — | Table Id Or Name |
recordId | string | Yes | — | Record Id |
rowCommentId | string | Yes | — | Row Comment Id |
text | string | Yes | — | The text value |
airtable_update_field
Update field Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
baseId | string | Yes | — | Base Id |
tableId | string | Yes | — | Table Id |
columnId | string | Yes | — | Column Id |
description | string | No | — | The new description for the field (optional). If present, must be a string no longer than 20,000 characters. |
name | string | No | — | The new name for the field (optional). |
airtable_update_interface_collaborator
Update interface collaborator Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
baseId | string | Yes | — | Base Id |
pageBundleId | string | Yes | — | Page Bundle Id |
userOrGroupId | string | Yes | — | User Or Group Id |
permissionLevel | string | Yes | — | Permission Level |
airtable_update_multiple_records
Update multiple records Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
baseId | string | Yes | — | Base Id |
tableIdOrName | string | Yes | — | Table Id Or Name |
performUpsert | object | No | — | Enables upsert behavior when set. fieldsToMergeOn will be used as an external ID to match records for updates. For records where no match is found, a new Airtable record will be created. |
records | object[] | Yes | — | The records value |
returnFieldsByFieldId | boolean | No | — | If set to true, records in the API response will key the fields object by field ID. Defaults to false when unset, which returns fields objects keyed by field name. |
typecast | boolean | No | — | If set to true, Airtable will try to convert string values into the appropriate cell value. This conversion is only performed on a best-effort basis. To ensure your data’s integrity, this should only be used when necessary. Defaults to false when unset. |
airtable_update_record
Update record Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
baseId | string | Yes | — | Base Id |
tableIdOrName | string | Yes | — | Table Id Or Name |
recordId | string | Yes | — | Record Id |
fields | object | Yes | — | The fields value |
returnFieldsByFieldId | boolean | No | — | An optional boolean value that lets you return field objects keyed by the field id. This defaults to false, which returns field objects where the key is the field name. |
typecast | boolean | No | — | The Airtable API will perform best-effort automatic data conversion from string values if the typecast parameter is passed in. Automatic conversion is disabled by default to ensure data integrity, but it may be helpful for integrating with 3rd party data sources. |
airtable_update_table
Update table Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
baseId | string | Yes | — | Base Id |
tableIdOrName | string | Yes | — | Table Id Or Name |
dateDependencySettings | object | No | — | Configuration for a table’s date dependency settings. |
description | string | No | — | The new description for the table (optional). If present, must be a string no longer than 20,000 characters. |
name | string | No | — | The new name for the table (optional). |
airtable_update_workspace_collaborator
Update workspace collaborator Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Workspace Id |
userOrGroupId | string | Yes | — | User Or Group Id |
permissionLevel | object | Yes | — | Permission Level |
airtable_update_workspace_restrictions
Update workspace restrictions Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Workspace Id |
inviteCreationRestriction | string | No | — | Invite Creation Restriction |
shareCreationRestriction | string | No | — | Share Creation Restriction |

