> ## 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 > Bases, tables, and records **Server path:** `/airtable` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | ------------------------------------------------------------------------------------------------- | ------------------------------------ | | [`airtable_add_base_collaborator`](#airtable_add_base_collaborator) | Add base collaborator | | [`airtable_add_interface_collaborator`](#airtable_add_interface_collaborator) | Add interface collaborator | | [`airtable_add_workspace_collaborator`](#airtable_add_workspace_collaborator) | Add workspace collaborator | | [`airtable_audit_log_events`](#airtable_audit_log_events) | Audit log events | | [`airtable_change_events`](#airtable_change_events) | Change events | | [`airtable_create_a_webhook`](#airtable_create_a_webhook) | Create a webhook | | [`airtable_create_audit_log_request`](#airtable_create_audit_log_request) | Create audit log request | | [`airtable_create_base`](#airtable_create_base) | Create base | | [`airtable_create_base_from_package_enterprise`](#airtable_create_base_from_package_enterprise) | Create base from package | | [`airtable_create_comment`](#airtable_create_comment) | Create comment | | [`airtable_create_descendant_enterprise`](#airtable_create_descendant_enterprise) | Create descendant enterprise | | [`airtable_create_ediscovery_export`](#airtable_create_ediscovery_export) | Create eDiscovery export | | [`airtable_create_field`](#airtable_create_field) | Create field | | [`airtable_create_records`](#airtable_create_records) | Create records | | [`airtable_create_table`](#airtable_create_table) | Create table | | [`airtable_create_workspace`](#airtable_create_workspace) | Create workspace | | [`airtable_delete_a_webhook`](#airtable_delete_a_webhook) | Delete a webhook | | [`airtable_delete_base`](#airtable_delete_base) | Delete base | | [`airtable_delete_base_collaborator`](#airtable_delete_base_collaborator) | Delete base collaborator | | [`airtable_delete_base_invite`](#airtable_delete_base_invite) | Delete base invite | | [`airtable_delete_block_installation`](#airtable_delete_block_installation) | Delete block installation | | [`airtable_delete_comment`](#airtable_delete_comment) | Delete comment | | [`airtable_delete_interface_collaborator`](#airtable_delete_interface_collaborator) | Delete interface collaborator | | [`airtable_delete_interface_invite`](#airtable_delete_interface_invite) | Delete interface invite | | [`airtable_delete_multiple_records`](#airtable_delete_multiple_records) | Delete multiple records | | [`airtable_delete_record`](#airtable_delete_record) | Delete record | | [`airtable_delete_share`](#airtable_delete_share) | Delete share | | [`airtable_delete_user_by_id`](#airtable_delete_user_by_id) | Delete user by id | | [`airtable_delete_users_by_email`](#airtable_delete_users_by_email) | Delete users by email | | [`airtable_delete_view`](#airtable_delete_view) | Delete view | | [`airtable_delete_workspace`](#airtable_delete_workspace) | Delete workspace | | [`airtable_delete_workspace_collaborator`](#airtable_delete_workspace_collaborator) | Delete workspace collaborator | | [`airtable_delete_workspace_invite`](#airtable_delete_workspace_invite) | Delete workspace invite | | [`airtable_enable_disable_webhook_notifications`](#airtable_enable_disable_webhook_notifications) | Enable/disable webhook notifications | | [`airtable_get_audit_log_request`](#airtable_get_audit_log_request) | Get audit log request | | [`airtable_get_base_collaborators`](#airtable_get_base_collaborators) | Get base collaborators | | [`airtable_get_base_schema`](#airtable_get_base_schema) | Get base schema | | [`airtable_get_ediscovery_export`](#airtable_get_ediscovery_export) | Get eDiscovery export | | [`airtable_get_enterprise`](#airtable_get_enterprise) | Get enterprise | | [`airtable_get_interface`](#airtable_get_interface) | Get interface | | [`airtable_get_record`](#airtable_get_record) | Get record | | [`airtable_get_user_by_id`](#airtable_get_user_by_id) | Get user by id | | [`airtable_get_user_group`](#airtable_get_user_group) | Get user group | | [`airtable_get_user_id_scopes`](#airtable_get_user_id_scopes) | Get user info | | [`airtable_get_users_by_id_or_email`](#airtable_get_users_by_id_or_email) | Get users by id or email | | [`airtable_get_view_metadata`](#airtable_get_view_metadata) | Get view metadata | | [`airtable_get_workspace_collaborators`](#airtable_get_workspace_collaborators) | Get workspace collaborators | | [`airtable_grant_admin_access`](#airtable_grant_admin_access) | Grant admin access | | [`airtable_list_audit_log_requests`](#airtable_list_audit_log_requests) | List audit log requests | | [`airtable_list_bases`](#airtable_list_bases) | List bases | | [`airtable_list_block_installations`](#airtable_list_block_installations) | List block installations | | [`airtable_list_comments`](#airtable_list_comments) | List comments | | [`airtable_list_ediscovery_export`](#airtable_list_ediscovery_export) | List eDiscovery exports | | [`airtable_list_enterprise_packages`](#airtable_list_enterprise_packages) | List packages | | [`airtable_list_records`](#airtable_list_records) | List records | | [`airtable_list_shares`](#airtable_list_shares) | List shares | | [`airtable_list_views`](#airtable_list_views) | List views | | [`airtable_list_webhook_payloads`](#airtable_list_webhook_payloads) | List webhook payloads | | [`airtable_list_webhooks`](#airtable_list_webhooks) | List webhooks | | [`airtable_logout_user`](#airtable_logout_user) | Logout user | | [`airtable_manage_block_installation`](#airtable_manage_block_installation) | Manage block installation | | [`airtable_manage_share`](#airtable_manage_share) | Manage share | | [`airtable_manage_user`](#airtable_manage_user) | Manage user | | [`airtable_manage_user_batched`](#airtable_manage_user_batched) | Manage user batched | | [`airtable_manage_user_membership`](#airtable_manage_user_membership) | Manage user membership | | [`airtable_move_base`](#airtable_move_base) | Move base | | [`airtable_move_user_groups`](#airtable_move_user_groups) | Move user groups | | [`airtable_move_workspaces`](#airtable_move_workspaces) | Move workspaces | | [`airtable_post_sync_api_endpoint`](#airtable_post_sync_api_endpoint) | Sync CSV data | | [`airtable_refresh_a_webhook`](#airtable_refresh_a_webhook) | Refresh a webhook | | [`airtable_remove_user_from_enterprise`](#airtable_remove_user_from_enterprise) | Remove user from enterprise | | [`airtable_revoke_admin_access`](#airtable_revoke_admin_access) | Revoke admin access | | [`airtable_update_collaborator_base_permission`](#airtable_update_collaborator_base_permission) | Update collaborator base permission | | [`airtable_update_comment`](#airtable_update_comment) | Update comment | | [`airtable_update_field`](#airtable_update_field) | Update field | | [`airtable_update_interface_collaborator`](#airtable_update_interface_collaborator) | Update interface collaborator | | [`airtable_update_multiple_records`](#airtable_update_multiple_records) | Update multiple records | | [`airtable_update_record`](#airtable_update_record) | Update record | | [`airtable_update_table`](#airtable_update_table) | Update table | | [`airtable_update_workspace_ai_allowlist`](#airtable_update_workspace_ai_allowlist) | Update workspace AI allowlist | | [`airtable_update_workspace_collaborator`](#airtable_update_workspace_collaborator) | Update workspace collaborator | | [`airtable_update_workspace_restrictions`](#airtable_update_workspace_restrictions) | Update workspace restrictions | *** ## 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**. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "collaborators": { "type": "array", "description": "This endpoint accepts two types of collaborators: **individual user** and **group**." } }, "required": [ "PCID", "baseId", "collaborators" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "pageBundleId": { "type": "string", "description": "Page Bundle Id" }, "collaborators": { "type": "array", "description": "This endpoint accepts two types of collaborators: **individual user** and **group**. This route currently supports adding only one collaborator at a time." } }, "required": [ "PCID", "baseId", "pageBundleId", "collaborators" ] } ``` *** ## 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**. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Workspace Id" }, "collaborators": { "type": "array", "description": "This endpoint accepts two types of collaborators: **individual user** and **group**." } }, "required": [ "PCID", "workspaceId", "collaborators" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "startTime": { "type": "string", "description": "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": { "type": "string", "description": "Latest audit log event to retrieve (exclusive), in ISO 8601 date time format. Optional. Defaults to now." }, "originatingUserId": { "type": "array", "items": { "type": "string" }, "description": "Retrieve audit log events originating from the provided user ID or IDs (maximum 100). Optional." }, "eventType": { "type": "array", "items": { "type": "string", "enum": [ "createBase", "deleteBase", "moveBase", "duplicateBase", "viewBase", "updateBaseName", "updateBaseGuideText", "restoreBaseFromSnapshot", "restoreBaseFromTrash", "applyChangesFromSandbox", "enableShare", "disableShare", "configureShare", "regenerateShare", "viewShare", "downloadAttachment", "addBaseInviteLink", "removeBaseInviteLink", "configureBaseInviteLink", "changeBaseAiPermissions", "createSandboxBase", "inviteBaseCollaborator", "addBaseCollaborator", "changeBaseInvitePermission", "changeBaseCollaboratorPermission", "removeBaseCollaborator", "uninviteBaseCollaborator", "resendBaseInvite", "createCustomDomain", "deleteCustomDomain", "createGroup", "deleteGroup", "moveGroup", "addGroupMember", "changeGroupMemberRole", "removeGroupMember", "deleteGroupInvite", "resendGroupInvite", "inviteGroupMember", "createRole", "loginUser", "claimUser", "unclaimUser", "createUser", "deleteUser", "provisionUser", "deactivateUser", "updateUserEmail", "changePassword", "updateUserProfilePicture", "userAssignedLicense", "userAssignedGridGlobalLicense", "createServiceAccount", "deleteServiceAccount", "moveServiceAccount", "acceptTermsOfUse", "linkSsoIdentity", "updateSsoIdentity", "createSsoExternalUser", "addTwoFactorAuthenticationStrategy", "removeTwoFactorAuthenticationStrategy", "regenerateTwoFactorAuthenticationBackupCodes", "setDefaultTwoFactorAuthenticationStrategy", "disableTwoFactorAuthentication", "createOauthAccessToken", "refreshOauthAccessToken", "createSyncIntegrationSource", "renameSyncIntegrationSource", "reconnectSyncIntegrationSource", "deleteSyncIntegrationSource", "connectSyncIntegrationToTable", "changeSyncIntegrationTableSource", "disconnectSyncIntegrationFromTable", "createPersonalAccessToken", "grantEnterpriseAdminAccess", "revokeEnterpriseAdminAccess", "grantEnterpriseUpgraderAccess", "revokeEnterpriseUpgraderAccess", "updateEnterpriseName", "deleteEnterpriseStripeCard", "updateEnterpriseStripeCard", "updateEnterprisePaymentMethod", "updateEnterpriseInvoiceDetails", "createOrgUnit", "deleteOrgUnit", "createEdiscoveryExport", "updateSettingLock", "updateOrgUnitConnection", "updateMembershipCaptureType", "updateEnterpriseTaxDetails", "deleteEnterpriseTaxDetails", "changeEnterpriseInviteRestrictions", "changeEnterprisePortalInviteRestrictions", "changeEnterpriseGlobalShareRestrictions", "changeEnterpriseInterfaceOrgWideSharingRestrictions", "changeEnterpriseGroupCreateRestrictions", "changeEnterpriseIpAddressAccessRestrictions", "changeEnterpriseExtensionConfigurationRestrictions", "changeEnterpriseDataRetentionPolicy", "changeEnterpriseAiRestrictionPolicy", "changeEnterpriseMfaPolicy", "changeEnterpriseLicenseUpgradeRequestConfig", "changeDataTableInstallationRestrictions", "changeEnterpriseColors", "changeEnterpriseTermsOfUseOptions", "changeEnterpriseDataExportControlRestrictions", "changeEnterpriseSensitivityLabels", "changeEnterpriseSensitivityLabelSetting", "changeEnterpriseWorkspaceAppCreationRestrictions", "addUserOrGroupToEnterpriseRestrictionAllowlist", "removeUserOrGroupFromEnterpriseRestrictionAllowlist", "applyDefaultEnterpriseSetting", "createSsoIdentityProvider", "updateSsoIdentityProvider", "deleteSsoIdentityProvider", "setEmailDomainSsoPiggybacking", "clearEmailDomainSsoPiggybacking", "requestLicenseUpgrade", "approveLicenseUpgradeRequest", "denyLicenseUpgradeRequest", "createManagedApp", "createComponent", "deleteManagedApp", "deleteComponent", "publishManagedApp", "publishComponent", "updateManagedAppName", "updateComponentName", "addManagedAppAudienceMember", "addComponentAudienceMember", "removeManagedAppAudienceMember", "removeComponentAudienceMember", "addManagedAppCollaborator", "addComponentCollaborator", "changeManagedAppCollaboratorPermission", "changeComponentCollaboratorPermission", "removeManagedAppCollaborator", "removeComponentCollaborator", "createPublishedDataset", "changePublishedDatasetName", "deletePublishedDataset", "updatePublishedDatasetOwner", "updatePublishedDatasetAudiences", "updatePublishedDatasetVerificationStatus", "deactivatePublishedDataset", "reactivatePublishedDataset", "createDataTable", "updateDataTableSource", "updateDataTableSingleSelectColumnChoices", "deleteDataTable", "createPublishedDatasetFromDataTable", "updateDataTablePublishedDataSet", "updateDataTablePublishedDataSetStatus", "abortDataTableImportInProgress", "moveDataTable", "createWorkspace", "deleteWorkspace", "restoreWorkspaceFromTrash", "moveWorkspace", "changeWorkspaceSharingRestrictions", "addWorkspaceInviteLink", "configureWorkspaceInviteLink", "removeWorkspaceInviteLink", "updateWorkspaceName", "changeWorkspaceAiPermissions", "inviteWorkspaceCollaborator", "addWorkspaceCollaborator", "changeWorkspaceInvitePermission", "changeWorkspaceCollaboratorPermission", "removeWorkspaceCollaborator", "uninviteWorkspaceCollaborator", "resendWorkspaceInvite", "viewInterface", "deleteInterface", "restoreInterfaceFromTrash", "duplicateInterface", "createInterface", "updateInterfaceName", "publishInterface", "unpublishInterface", "openRecordDetailsFromInterface", "viewForm", "publishForm", "unpublishForm", "configureFormSharingSettings", "inviteInterfaceCollaborator", "addInterfaceCollaborator", "changeInterfaceInvitePermission", "changeInterfaceCollaboratorPermission", "removeInterfaceCollaborator", "uninviteInterfaceCollaborator", "resendInterfaceInvite", "configureInterfaceOrgWideSharing", "createPortal", "deletePortal", "invitePortalCollaborator", "addPortalCollaborator", "changePortalInvitePermission", "changePortalCollaboratorPermission", "removePortalCollaborator", "uninvitePortalCollaborator", "downloadCSV", "aiCreditConsumed", "moderateAiContent", "installSolution", "updateSolutionVersion", "updateAutomationSubscribers" ] }, "description": "Retrieve audit log events falling under the provided event type or event types (maximum 100). Optional." }, "modelId": { "type": "array", "items": { "type": "string" }, "description": "Retrieve audit log events taking action on, or involving, the provided model ID or IDs (maximum 100). Optional." }, "pageSize": { "type": "number", "description": "The number of events per page. Maximum value of 1000; defaults to 10." }, "sortOrder": { "type": "string", "description": "Sort the events by timestamp in ascending or descending order. Defaults to descending.", "enum": [ "descending", "ascending" ] }, "previous": { "type": "string", "description": "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": { "type": "string", "description": "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": { "type": "array", "items": { "type": "string", "enum": [ "base", "baseCollaboration", "groups", "role", "share", "user", "twoFactorAuthentication", "oauth", "personalAccessToken", "enterprise", "enterpriseSettings", "enterpriseLicenses", "managedApps", "components", "publishedDataSets", "dataTable", "workspace", "workspaceCollaboration", "interface", "standaloneForms", "interfaceCollaboration", "view", "ai", "solution", "portal", "workflow", "customDomain" ] }, "description": "The category value" } }, "required": [ "PCID", "enterpriseAccountId" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "startTime": { "type": "string", "description": "Earliest change event to retrieve (inclusive), in ISO 8601 date time format. Optional." }, "endTime": { "type": "string", "description": "Latest change event to retrieve (exclusive), in ISO 8601 date time format. Optional." }, "pageSize": { "type": "number", "description": "The number of records per page. Maximum value of 100; defaults to 10." }, "offset": { "type": "string", "description": "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." } }, "required": [ "PCID", "enterpriseAccountId" ] } ``` *** ## 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](/api/webhooks-overview#webhook-notification-delivery). | | `specification` | object | Yes | — | A JSON object that describe the types of changes the webhook is interested in. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "notificationUrl": { "type": "string", "description": "An optional url that can receive notification pings. [See notification delivery](/api/webhooks-overview#webhook-notification-delivery)." }, "specification": { "type": "object", "description": "A JSON object that describe the types of changes the webhook is interested in.", "properties": { "options": { "type": "object", "description": "A single webhook may watch changes in a table, view, or base. The specification defines the types of the changes that are included in the webhook's payloads. Note that tables, fields, and views in the specification must be specified by ID rather than by name. You may find the IDs for each of these with the manage fields UI." } }, "required": [ "options" ] } }, "required": [ "PCID", "baseId", "specification" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "filter": { "type": "string", "description": "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": { "type": "string", "description": "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." } }, "required": [ "PCID", "enterpriseAccountId", "timePeriod" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "The name for the new base." }, "tables": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "The description value" }, "fields": { "type": "array", "description": "The fields value" }, "name": { "type": "string", "description": "The name value" } }, "required": [ "name", "fields" ] }, "description": "A list of JSON objects representing the tables that will be created along with the base." }, "workspaceId": { "type": "string", "description": "The workspace where the base will be created." } }, "required": [ "PCID", "name", "tables", "workspaceId" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "packageId": { "type": "string", "description": "Package Id" }, "description": { "type": "string", "description": "Optional description for the base." }, "name": { "type": "string", "description": "The name for the new base." }, "packageReleaseId": { "type": "string", "description": "The package release ID to install." }, "workspaceId": { "type": "string", "description": "The workspace where the base will be created." } }, "required": [ "PCID", "enterpriseAccountId", "packageId", "name", "packageReleaseId", "workspaceId" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "tableIdOrName": { "type": "string", "description": "Table Id Or Name" }, "recordId": { "type": "string", "description": "Record Id" }, "parentCommentId": { "type": "string", "description": "A comment ID" }, "text": { "type": "string", "description": "The text value" } }, "required": [ "PCID", "baseId", "tableIdOrName", "recordId", "text" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "name": { "type": "string", "description": "The name value" } }, "required": [ "PCID", "enterpriseAccountId", "name" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "baseId": { "type": "string", "description": "Base ID to create eDiscovery export for." }, "includeCsvFormat": { "type": "boolean", "description": "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": { "type": "boolean", "description": "If set, an email will be sent to the user who initiated the export once the export is ready for download." } }, "required": [ "PCID", "enterpriseAccountId", "baseId" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "tableId": { "type": "string", "description": "Table Id" }, "body": { "description": "This identical to Field type and options, with an additional `name` and `description` property on all types" } }, "required": [ "PCID", "baseId", "tableId" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "tableIdOrName": { "type": "string", "description": "Table Id Or Name" }, "fields": { "type": "object", "description": "Create **a single** record" }, "records": { "type": "array", "items": { "type": "object", "properties": { "fields": { "type": "object", "description": "The fields value" } }, "required": [ "fields" ] }, "description": "Create **multiple** records Pass in multiple records to create multiple in one request" }, "returnFieldsByFieldId": { "type": "boolean", "description": "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": { "type": "boolean", "description": "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." } }, "required": [ "PCID", "baseId", "tableIdOrName" ] } ``` *** ## 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](/api/model/field-type) 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "description": { "type": "string", "description": "The description for the table (optional). If present, must be a non-empty string no longer than 20,000 characters." }, "fields": { "type": "array", "description": "A list of JSON objects representing the fields in the table. Refer to [field types](/api/model/field-type) for supported field types, the write format for field options, and other specifics for certain field types." }, "name": { "type": "string", "description": "The name for the table." } }, "required": [ "PCID", "baseId", "fields", "name" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "The enterprise account that the workspace will be created in." }, "name": { "type": "string", "description": "Name of the workspace to be created." } }, "required": [ "PCID", "enterpriseAccountId", "name" ] } ``` *** ## airtable\_delete\_a\_webhook Delete a webhook **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ----------- | | `baseId` | string | Yes | — | Base Id | | `webhookId` | string | Yes | — | Webhook Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "webhookId": { "type": "string", "description": "Webhook Id" } }, "required": [ "PCID", "baseId", "webhookId" ] } ``` *** ## airtable\_delete\_base Delete base **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ----------- | | `baseId` | string | Yes | — | Base Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" } }, "required": [ "PCID", "baseId" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "userOrGroupId": { "type": "string", "description": "User Or Group Id" } }, "required": [ "PCID", "baseId", "userOrGroupId" ] } ``` *** ## airtable\_delete\_base\_invite Delete base invite **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ----------- | | `baseId` | string | Yes | — | Base Id | | `inviteId` | string | Yes | — | Invite Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "inviteId": { "type": "string", "description": "Invite Id" } }, "required": [ "PCID", "baseId", "inviteId" ] } ``` *** ## airtable\_delete\_block\_installation Delete block installation **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------ | -------- | ------- | --------------------- | | `baseId` | string | Yes | — | Base Id | | `blockInstallationId` | string | Yes | — | Block Installation Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "blockInstallationId": { "type": "string", "description": "Block Installation Id" } }, "required": [ "PCID", "baseId", "blockInstallationId" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "tableIdOrName": { "type": "string", "description": "Table Id Or Name" }, "recordId": { "type": "string", "description": "Record Id" }, "rowCommentId": { "type": "string", "description": "Row Comment Id" } }, "required": [ "PCID", "baseId", "tableIdOrName", "recordId", "rowCommentId" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "pageBundleId": { "type": "string", "description": "Page Bundle Id" }, "userOrGroupId": { "type": "string", "description": "User Or Group Id" } }, "required": [ "PCID", "baseId", "pageBundleId", "userOrGroupId" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "pageBundleId": { "type": "string", "description": "Page Bundle Id" }, "inviteId": { "type": "string", "description": "Invite Id" } }, "required": [ "PCID", "baseId", "pageBundleId", "inviteId" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "tableIdOrName": { "type": "string", "description": "Table Id Or Name" }, "records": { "type": "array", "items": { "type": "string" }, "description": "The recordIds of each record to be deleted." } }, "required": [ "PCID", "baseId", "tableIdOrName" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "tableIdOrName": { "type": "string", "description": "Table Id Or Name" }, "recordId": { "type": "string", "description": "Record Id" } }, "required": [ "PCID", "baseId", "tableIdOrName", "recordId" ] } ``` *** ## airtable\_delete\_share Delete share **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ----------- | | `baseId` | string | Yes | — | Base Id | | `shareId` | string | Yes | — | Share Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "shareId": { "type": "string", "description": "Share Id" } }, "required": [ "PCID", "baseId", "shareId" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "userId": { "type": "string", "description": "User Id" } }, "required": [ "PCID", "enterpriseAccountId", "userId" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "email": { "type": "array", "items": { "type": "string" }, "description": "The email value" } }, "required": [ "PCID", "enterpriseAccountId" ] } ``` *** ## airtable\_delete\_view Delete view **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ----------- | | `baseId` | string | Yes | — | Base Id | | `viewId` | string | Yes | — | View Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "viewId": { "type": "string", "description": "View Id" } }, "required": [ "PCID", "baseId", "viewId" ] } ``` *** ## airtable\_delete\_workspace Delete workspace **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------ | -------- | ------- | ------------ | | `workspaceId` | string | Yes | — | Workspace Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Workspace Id" } }, "required": [ "PCID", "workspaceId" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Workspace Id" }, "userOrGroupId": { "type": "string", "description": "User Or Group Id" } }, "required": [ "PCID", "workspaceId", "userOrGroupId" ] } ``` *** ## airtable\_delete\_workspace\_invite Delete workspace invite **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------ | -------- | ------- | ------------ | | `workspaceId` | string | Yes | — | Workspace Id | | `inviteId` | string | Yes | — | Invite Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Workspace Id" }, "inviteId": { "type": "string", "description": "Invite Id" } }, "required": [ "PCID", "workspaceId", "inviteId" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "webhookId": { "type": "string", "description": "Webhook Id" }, "enable": { "type": "boolean", "description": "The enable value" } }, "required": [ "PCID", "baseId", "webhookId", "enable" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "enterpriseAuditLogTaskId": { "type": "string", "description": "Enterprise Audit Log Task Id" } }, "required": [ "PCID", "enterpriseAccountId", "enterpriseAuditLogTaskId" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "include": { "type": "array", "items": { "type": "string", "enum": [ "collaborators", "inviteLinks", "interfaces", "packages" ] }, "description": "If specified, collaborators, interfaces, inviteLinks key, and/or packages will be included in the response object. Otherwise, they will be left out." } }, "required": [ "PCID", "baseId" ] } ``` *** ## 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) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "include": { "type": "array", "items": { "type": "string" }, "description": "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)" } }, "required": [ "PCID", "baseId" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "enterpriseTaskId": { "type": "string", "description": "Enterprise Task Id" } }, "required": [ "PCID", "enterpriseAccountId", "enterpriseTaskId" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "include": { "type": "array", "items": { "type": "string", "enum": [ "aggregated", "descendants" ] }, "description": "If specified, aggregated and/or descendants keys will be included in the response object. Otherwise, it will be left out." } }, "required": [ "PCID", "enterpriseAccountId" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "pageBundleId": { "type": "string", "description": "Page Bundle Id" }, "include": { "type": "array", "items": { "type": "string", "enum": [ "collaborators", "inviteLinks" ] }, "description": "Related resources to include" } }, "required": [ "PCID", "baseId", "pageBundleId" ] } ``` *** ## 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`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "tableIdOrName": { "type": "string", "description": "Table Id Or Name" }, "recordId": { "type": "string", "description": "Record Id" }, "cellFormat": { "type": "string", "description": "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`.", "enum": [ "json", "string" ] }, "returnFieldsByFieldId": { "type": "boolean", "description": "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": { "type": "boolean", "description": "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`." } }, "required": [ "PCID", "baseId", "tableIdOrName", "recordId" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "userId": { "type": "string", "description": "User Id" }, "include": { "type": "array", "items": { "type": "string", "enum": [ "collaborations", "aggregated", "descendants" ] }, "description": "If specified, collaborations, aggregated, and/or descendants keys will be included in the response object. Otherwise, they will be left out." } }, "required": [ "PCID", "enterpriseAccountId", "userId" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "groupId": { "type": "string", "description": "Group Id" }, "include": { "type": "array", "items": { "type": "string" }, "description": "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." } }, "required": [ "PCID", "groupId" ] } ``` *** ## airtable\_get\_user\_id\_scopes Get user info ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## airtable\_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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "email": { "type": "array", "items": { "type": "string" }, "description": "Email addresses to search by. If the request does not have any userIds, you must include at least one email address." }, "id": { "type": "array", "items": { "type": "string" }, "description": "User Ids to search by. If the request does not have any email addresses, you must include at least one userId." }, "include": { "type": "array", "items": { "type": "string", "enum": [ "collaborations", "aggregated", "descendants" ] }, "description": "Allows optionally including collaborations in response." } }, "required": [ "PCID", "enterpriseAccountId" ] } ``` *** ## 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) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "viewId": { "type": "string", "description": "View Id" }, "include": { "type": "array", "items": { "type": "string" }, "description": "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)" } }, "required": [ "PCID", "baseId", "viewId" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Workspace Id" }, "include": { "type": "array", "items": { "type": "string", "enum": [ "collaborators", "inviteLinks" ] }, "description": "If specified, collaborators or inviteLinks key will be included in the response object. Otherwise they will be left out." } }, "required": [ "PCID", "workspaceId" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "users": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string", "description": "The email value" }, "id": { "type": "string", "description": "A user ID" } } }, "description": "The users value" } }, "required": [ "PCID", "enterpriseAccountId", "users" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "pageSize": { "type": "number", "description": "The number of records per page. Maximum value of 100; defaults to 10." }, "offset": { "type": "number", "description": "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." } }, "required": [ "PCID", "enterpriseAccountId" ] } ``` *** ## airtable\_list\_bases List bases **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ---------------- | | `offset` | string | No | — | The offset value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "offset": { "type": "string", "description": "The offset value" } }, "required": [ "PCID" ] } ``` *** ## airtable\_list\_block\_installations List block installations **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ----------- | | `baseId` | string | Yes | — | Base Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" } }, "required": [ "PCID", "baseId" ] } ``` *** ## 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**. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "tableIdOrName": { "type": "string", "description": "Table Id Or Name" }, "recordId": { "type": "string", "description": "Record Id" }, "pageSize": { "type": "number", "description": "If specified, this will determine the number of comments to return. Must be less than or equal to 100. Default is 100." }, "offset": { "type": "string", "description": "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**." } }, "required": [ "PCID", "baseId", "tableIdOrName", "recordId" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "state": { "type": "string", "description": "Filter for exports with the specified state.", "enum": [ "pending", "processing", "error", "done" ] }, "pageSize": { "type": "number", "description": "The number of records per page. Maximum value of 100; defaults to 10." }, "offset": { "type": "number", "description": "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." } }, "required": [ "PCID", "enterpriseAccountId" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "shouldGetAllPackagesInGrid": { "type": "boolean", "description": "If true and the enterprise account is the root enterprise account, returns all packages across the entire enterprise grid. Defaults to false." } }, "required": [ "PCID", "enterpriseAccountId" ] } ``` *** ## 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](https://support.airtable.com/docs/supported-locale-modifiers-for-set-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](https://support.airtable.com/docs/formula-field-reference) 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](https://codepen.io/airtable/full/MeXqOg) to not only encode the formula but also create the entire url you need. Formulas can use field names or field IDs inside 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "tableIdOrName": { "type": "string", "description": "Table Id Or Name" }, "timeZone": { "description": "Timezone identifier" }, "userLocale": { "type": "string", "description": "The [user locale](https://support.airtable.com/docs/supported-locale-modifiers-for-set-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": { "type": "number", "description": "The number of records returned in each request. Must be less than or equal to 100. Default is 100." }, "maxRecords": { "type": "number", "description": "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": { "type": "string", "description": "To fetch the next page of records, include offset from the previous request in the next request's parameters." }, "view": { "description": "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": { "type": "array", "items": { "type": "object", "properties": { "direction": { "type": "string", "enum": [ "asc", "desc" ], "description": "The direction value" }, "field": { "type": "string", "description": "The field value" } }, "required": [ "field" ] }, "description": "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": { "type": "string", "description": "A [formula](https://support.airtable.com/docs/formula-field-reference) 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](https://codepen.io/airtable/full/MeXqOg) to not only encode the formula but also create the entire url you need. Formulas can use field names or field IDs inside 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": { "type": "string", "description": "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**.", "enum": [ "json", "string" ] }, "fields": { "type": "array", "items": { "type": "string" }, "description": "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": { "type": "boolean", "description": "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": { "type": "boolean", "description": "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": { "type": "array", "items": { "type": "string" }, "description": "An optional field that, if specified, includes **commentCount** on each record returned." } }, "required": [ "PCID", "baseId", "tableIdOrName" ] } ``` *** ## airtable\_list\_shares List shares **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ----------- | | `baseId` | string | Yes | — | Base Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" } }, "required": [ "PCID", "baseId" ] } ``` *** ## 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) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "include": { "type": "array", "items": { "type": "string" }, "description": "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)" } }, "required": [ "PCID", "baseId" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "webhookId": { "type": "string", "description": "Webhook Id" }, "cursor": { "type": "number", "description": "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": { "type": "number", "description": "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." } }, "required": [ "PCID", "baseId", "webhookId" ] } ``` *** ## airtable\_list\_webhooks List webhooks **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ----------- | | `baseId` | string | Yes | — | Base Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" } }, "required": [ "PCID", "baseId" ] } ``` *** ## airtable\_logout\_user Logout user **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------ | -------- | ------- | --------------------- | | `enterpriseAccountId` | string | Yes | — | Enterprise Account Id | | `userId` | string | Yes | — | User Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "userId": { "type": "string", "description": "User Id" } }, "required": [ "PCID", "enterpriseAccountId", "userId" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "blockInstallationId": { "type": "string", "description": "Block Installation Id" }, "state": { "type": "string", "description": "The state value", "enum": [ "enabled", "disabled" ] } }, "required": [ "PCID", "baseId", "blockInstallationId", "state" ] } ``` *** ## 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](https://support.airtable.com/docs/workspace-sharing-restrictions). These restrictions are not applicable when disabling a share. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "shareId": { "type": "string", "description": "Share Id" }, "state": { "type": "string", "description": "When _enabling_ a share a user is subject to [sharing restrictions](https://support.airtable.com/docs/workspace-sharing-restrictions). These restrictions are not applicable when disabling a share.", "enum": [ "enabled", "disabled" ] } }, "required": [ "PCID", "baseId", "shareId", "state" ] } ``` *** ## 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](/api/org-management-glossary#provisioned-user) \| [deactivated](/api/org-management-glossary#deactivated-user) Can only change the state of [managed](/api/org-management-glossary#managed-user) users. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "userId": { "type": "string", "description": "User Id" }, "email": { "type": "string", "description": "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": { "type": "string", "description": "First Name" }, "lastName": { "type": "string", "description": "Last Name" }, "state": { "type": "string", "description": "[provisioned](/api/org-management-glossary#provisioned-user) | [deactivated](/api/org-management-glossary#deactivated-user) Can only change the state of [managed](/api/org-management-glossary#managed-user) users.", "enum": [ "provisioned", "deactivated" ] } }, "required": [ "PCID", "enterpriseAccountId", "userId" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "users": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string", "description": "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": { "type": "string", "description": "First Name" }, "id": { "type": "string", "description": "A user ID" }, "lastName": { "type": "string", "description": "Last Name" }, "state": { "type": "string", "enum": [ "provisioned", "deactivated" ], "description": "[provisioned](/api/org-management-glossary#provisioned-user) | [deactivated](/api/org-management-glossary#deactivated-user) Can only change the state of [managed](/api/org-management-glossary#managed-user) users." } } }, "description": "The users value" } }, "required": [ "PCID", "enterpriseAccountId", "users" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "users": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string", "description": "The email value" }, "id": { "type": "string", "description": "A user ID" }, "state": { "type": "string", "enum": [ "managed", "unmanaged" ], "description": "[managed](/api/org-management-glossary#managed-user) | [unmanaged](/api/org-management-glossary#unmanaged-user)" } }, "required": [ "state" ] }, "description": "The users value" } }, "required": [ "PCID", "enterpriseAccountId", "users" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Workspace Id" }, "baseId": { "type": "string", "description": "ID of the base to be moved" }, "targetIndex": { "type": "number", "description": "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": { "type": "string", "description": "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." } }, "required": [ "PCID", "workspaceId", "baseId", "targetWorkspaceId" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "groupIds": { "type": "array", "items": { "type": "string" }, "description": "ID of the groups to be moved. Up to 100 groupIds can be provided." }, "targetEnterpriseAccountId": { "type": "string", "description": "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." } }, "required": [ "PCID", "enterpriseAccountId", "groupIds", "targetEnterpriseAccountId" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "replacementOwnerId": { "type": "string", "description": "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": { "type": "string", "description": "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": { "type": "array", "items": { "type": "string" }, "description": "ID of the workspaces to be moved. Up to 100 workspaceIds can be provided." } }, "required": [ "PCID", "enterpriseAccountId", "targetEnterpriseAccountId", "workspaceIds" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "tableIdOrName": { "type": "string", "description": "Table Id Or Name" }, "apiEndpointSyncId": { "type": "string", "description": "Api Endpoint Sync Id" } }, "required": [ "PCID", "baseId", "tableIdOrName", "apiEndpointSyncId" ] } ``` *** ## airtable\_refresh\_a\_webhook Refresh a webhook **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ----------- | | `baseId` | string | Yes | — | Base Id | | `webhookId` | string | Yes | — | Webhook Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "webhookId": { "type": "string", "description": "Webhook Id" } }, "required": [ "PCID", "baseId", "webhookId" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "userId": { "type": "string", "description": "User Id" }, "isDryRun": { "type": "boolean", "description": "Is Dry Run" }, "removeFromDescendants": { "type": "boolean", "description": "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": { "type": "string", "description": "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." } }, "required": [ "PCID", "enterpriseAccountId", "userId" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "users": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string", "description": "The email value" }, "id": { "type": "string", "description": "A user ID" } } }, "description": "The users value" } }, "required": [ "PCID", "enterpriseAccountId", "users" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "userOrGroupId": { "type": "string", "description": "User Or Group Id" }, "permissionLevel": { "type": "string", "description": "Permission Level", "enum": [ "read", "comment", "edit", "create" ] } }, "required": [ "PCID", "baseId", "userOrGroupId", "permissionLevel" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "tableIdOrName": { "type": "string", "description": "Table Id Or Name" }, "recordId": { "type": "string", "description": "Record Id" }, "rowCommentId": { "type": "string", "description": "Row Comment Id" }, "text": { "type": "string", "description": "The text value" } }, "required": [ "PCID", "baseId", "tableIdOrName", "recordId", "rowCommentId", "text" ] } ``` *** ## 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). | | `options` | object | No | — | Type-specific field options to update. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "tableId": { "type": "string", "description": "Table Id" }, "columnId": { "type": "string", "description": "Column Id" }, "description": { "type": "string", "description": "The new description for the field (optional). If present, must be a string no longer than 20,000 characters." }, "name": { "type": "string", "description": "The new name for the field (optional)." }, "options": { "type": "object", "description": "Type-specific field options to update.", "properties": { "formula": { "type": "string", "description": "The new formula expression (formula fields only). Field references can use field IDs (e.g., {fldXXXXXXXXXXXXXX}) or field names (e.g., {My Field})." } } } }, "required": [ "PCID", "baseId", "tableId", "columnId" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "pageBundleId": { "type": "string", "description": "Page Bundle Id" }, "userOrGroupId": { "type": "string", "description": "User Or Group Id" }, "permissionLevel": { "type": "string", "description": "Permission Level", "enum": [ "read", "comment", "edit" ] } }, "required": [ "PCID", "baseId", "pageBundleId", "userOrGroupId", "permissionLevel" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "tableIdOrName": { "type": "string", "description": "Table Id Or Name" }, "performUpsert": { "type": "object", "description": "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.", "properties": { "fieldsToMergeOn": { "type": "array", "items": { "type": "string" }, "description": "An array with at least one and at most three field names or IDs. IDs must uniquely identify a single record. These cannot be computed fields (formulas, lookups, rollups), and must be one of the following types: number, text, long text, single select, multiple select, date." } }, "required": [ "fieldsToMergeOn" ] }, "records": { "type": "array", "items": { "type": "object", "properties": { "fields": { "type": "object", "description": "The fields value" }, "id": { "type": "string", "description": "The ID of the record to update. Required when **performUpsert** is undefined." } }, "required": [ "fields" ] }, "description": "The records value" }, "returnFieldsByFieldId": { "type": "boolean", "description": "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": { "type": "boolean", "description": "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." } }, "required": [ "PCID", "baseId", "tableIdOrName", "records" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "tableIdOrName": { "type": "string", "description": "Table Id Or Name" }, "recordId": { "type": "string", "description": "Record Id" }, "fields": { "type": "object", "description": "The fields value" }, "returnFieldsByFieldId": { "type": "boolean", "description": "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": { "type": "boolean", "description": "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." } }, "required": [ "PCID", "baseId", "tableIdOrName", "recordId", "fields" ] } ``` *** ## 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). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "tableIdOrName": { "type": "string", "description": "Table Id Or Name" }, "dateDependencySettings": { "type": "object", "description": "Configuration for a table's date dependency settings.", "properties": { "durationFieldId": { "type": "string", "description": "Must be an editable number field with unit in days." }, "endDateFieldId": { "type": "string", "description": "Must be an editable Date field." }, "holidays": { "type": "array", "items": { "type": "string" }, "description": "Set of holidays dates to skip when recalculating. Each date should be ISO-formatted. Has no effect if shouldSkipWeekendsAndHolidays is false." }, "isEnabled": { "type": "boolean", "description": "Whether the date dependency settings are enabled." }, "isForwardOnly": { "type": "boolean", "description": "Is Forward Only" }, "predecessorFieldId": { "type": "string", "description": "If present, must be an editable linked record field pointing to the same table." }, "reschedulingMode": { "type": "string", "description": "Determines how tasks are rescheduled relative to their predecessors. [See support article](https://support.airtable.com/docs/date-dependencies-in-airtable#supported-date-dependency-behavior-in-airtable) for more.", "enum": [ "flexible", "fixed", "none" ] }, "shouldSkipWeekendsAndHolidays": { "type": "boolean", "description": "Whether to skip weekends and holidays when recalculating." }, "startDateFieldId": { "type": "string", "description": "Must be an editable Date field." } }, "required": [ "startDateFieldId", "endDateFieldId", "durationFieldId", "predecessorFieldId", "isEnabled", "shouldSkipWeekendsAndHolidays", "holidays", "reschedulingMode" ] }, "description": { "type": "string", "description": "The new description for the table (optional). If present, must be a string no longer than 20,000 characters." }, "name": { "type": "string", "description": "The new name for the table (optional)." } }, "required": [ "PCID", "baseId", "tableIdOrName" ] } ``` *** ## airtable\_update\_workspace\_ai\_allowlist Update workspace AI allowlist **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------------------- | --------- | -------- | ------- | ----------------------------- | | `enterpriseAccountId` | string | Yes | — | Enterprise Account Id | | `includeDescendantWorkspaces` | boolean | No | — | Include Descendant Workspaces | | `workspaces` | object\[] | Yes | — | The workspaces value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "includeDescendantWorkspaces": { "type": "boolean", "description": "Include Descendant Workspaces" }, "workspaces": { "type": "array", "items": { "type": "object", "properties": { "isAllowed": { "type": "boolean", "description": "Is Allowed" }, "workspaceId": { "type": "string", "description": "Workspace Id" } }, "required": [ "workspaceId", "isAllowed" ] }, "description": "The workspaces value" } }, "required": [ "PCID", "enterpriseAccountId", "workspaces" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Workspace Id" }, "userOrGroupId": { "type": "string", "description": "User Or Group Id" }, "permissionLevel": { "description": "Permission Level" } }, "required": [ "PCID", "workspaceId", "userOrGroupId", "permissionLevel" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Workspace Id" }, "inviteCreationRestriction": { "type": "string", "description": "Invite Creation Restriction", "enum": [ "unrestricted", "onlyOwners" ] }, "shareCreationRestriction": { "type": "string", "description": "Share Creation Restriction", "enum": [ "unrestricted", "onlyOwners" ] } }, "required": [ "PCID", "workspaceId" ] } ```