CINXE.COM

<!DOCTYPE html> <html style="overflow:auto" lang="en"><head><meta charSet="utf-8"/><meta name="theme-color" content="#ffffff"/><meta name="description" content="Airtable is a low-code platform for building collaborative apps. Customize your workflow, collaborate, and achieve ambitious outcomes. Get started for free."/><meta name="apple-itunes-app" content="app-id=914172636"/><meta name="twitter:card" content="summary_large_image"/><meta name="twitter:site" content="@airtable"/><meta property="fb:app_id" content="1457397314575627"/><meta property="og:site_name" content="Airtable"/><meta property="og:title" content="Airtable | Everyone's app platform"/><meta property="og:type" content="website"/><meta property="og:description" content="Airtable is a low-code platform for building collaborative apps. Customize your workflow, collaborate, and achieve ambitious outcomes. Get started for free."/><meta property="og:image" content="https://static.airtable.com/images/oembed/airtable_brand.png"/><meta http-equiv="x-ua-compatible" content="ie=edge"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Airtable Web API</title><script nonce="KGonNqmdinEb" src="https://static.airtable.com/js/lib/onetrust/202407.1.0/scripttemplates/otSDKStub.js" data-domain-script="2eda840d-10c3-46d7-9084-4cade1b1a306"></script><script type="text/javascript" nonce="KGonNqmdinEb">function OptanonWrapper() { var wasAlertBoxClosedYet = window.Optanon != undefined && window.Optanon.IsAlertBoxClosed(); /** * Code to automatically delete optional cookies after a user opts out. * Code is adapted from https://my.onetrust.com/s/article/UUID-b2d72003-853b-e75b-e337-c6d26ea327eb?language=en_US */ if (typeof OptanonWrapperCount == 'undefined') { getInitialCookieGroups(); } deleteCookieGroups(activeCookieGroups); function getInitialCookieGroups() { OptanonWrapperCount = ""; // OnetrustActiveGroups is defined by the OneTrust SDK. activeCookieGroups = OnetrustActiveGroups; } function deleteCookieGroups(cookieGroups) { var dataDomainGroups = JSON.parse(JSON.stringify(Optanon.GetDomainData().Groups)); var deletedGroupIds = getInactiveGroupIds(cookieGroups, OnetrustActiveGroups); if (deletedGroupIds.length != 0 && dataDomainGroups.length != 0) { for (var i = 0; i < dataDomainGroups.length; i++) { var customGroupId = dataDomainGroups[i]['CustomGroupId']; if (customGroupId != '' && deletedGroupIds.includes(customGroupId) ) { var domainGroupCookies = dataDomainGroups[i]['Cookies']; for (var j = 0; j < domainGroupCookies.length; j++) { var cookieName = domainGroupCookies[j].Name deleteCookieByNameForCurrentHost(cookieName); } } var domainGroupHosts = dataDomainGroups[i]['Hosts']; for (var j = 0; j < domainGroupHosts.length; j++) { var hostId = domainGroupHosts[j].HostId; var hostCookies = domainGroupHosts[j].Cookies; if (deletedGroupIds.includes(hostId)) { for (var k = 0; k < hostCookies.length; k++) { deleteCookieByNameForCurrentHost(hostCookies[k].Name); } } } } } getInitialCookieGroups(); // Reassign new group IDs } // Get inactive groups so we can delete them function getInactiveGroupIds(customGroupId, activeGroup) { // Initial OnetrustActiveGroups customGroupId = customGroupId.split(','); customGroupId = customGroupId.filter(Boolean); // After action OnetrustActiveGroups activeGroup = activeGroup.split(','); activeGroup = activeGroup.filter(Boolean); var result = []; for (var i = 0; i < customGroupId.length; i++) { if (activeGroup.indexOf(customGroupId[i]) <= -1) { result.push(customGroupId[i]); } } return result; } function deleteCookieByNameForCurrentHost(cookieName) { // Delete root path cookies domainName = window.location.hostname; var topLevelDomain = domainName; if (domainName.startsWith('www.')) { topLevelDomain = domainName.substr(4); // Remove "www." } else if (domainName.startsWith('.')) { topLevelDomain = domainName.substr(1); // Remove leading dot } // Modifying document.cookie like this will expire any cookies we set MaxAge for, since we're setting it to -99999999 var cookieMaxAgeToDeleteCookie = '-99999999'; var domainPrefixes = ['', '.', 'www.']; for (var prefixIndex = 0; prefixIndex < domainPrefixes.length; prefixIndex++) { var domainToExpireFor = domainPrefixes[prefixIndex] + topLevelDomain; document.cookie = cookieName + '=; Max-Age=' + cookieMaxAgeToDeleteCookie + '; Path=/;Domain=' + topLevelDomain; document.cookie = cookieName + '=; Max-Age=' + cookieMaxAgeToDeleteCookie + '; Path=/;'; } // Delete the cookie from LocalStorage. We probably don't need this most of the time, but // OneTrust recommends doing it anyway, in case vendors store data there localStorage.removeItem(cookieName); // Loop through path hierarchy and delete potential cookies at each path. var pathArray = window.location.pathname.split('/'); for (var i = 0; i < pathArray.length; i++) { if (pathArray[i]) { var currentPath = pathArray.slice(0, i + 1).join('/'); document.cookie = cookieName + '=; Max-Age=' + cookieMaxAgeToDeleteCookie + '; Path=' + currentPath + ';Domain=' + topLevelDomain; document.cookie = cookieName+ '=; Max-Age=' + cookieMaxAgeToDeleteCookie + '; Path=' + currentPath + ';'; // Account for trailing slash document.cookie = cookieName + '=; Max-Age=' + cookieMaxAgeToDeleteCookie + '; Path=' + currentPath + '/;Domain=' + topLevelDomain; document.cookie = cookieName + '=; Max-Age=' + cookieMaxAgeToDeleteCookie + '; Path=' + currentPath + '/;'; } } } /** * Code to automatically refresh the page when the user's consent status changes. * Consent status is updated when the user clicks confirm/reject on the cookie banner. * window.Optanon is the cookie banner SDK's global object. */ if (window.Optanon != undefined) { window.Optanon.OnConsentChanged(function (event) { if (wasAlertBoxClosedYet == false) { window.location.reload(); } }); } }</script><script nonce="KGonNqmdinEb" src="https://static.airtable.com/js/lib/onetrust/202407.1.0/consent/2eda840d-10c3-46d7-9084-4cade1b1a306/OtAutoBlock.js"></script><link nonce="KGonNqmdinEb" rel="stylesheet" type="text/css" href="/css/compiled/developers/rest_api.css?v=e5008d8b6d6bd98d-8"/><link rel="canonical" href="https://www.airtable.com/developers/web/api/introduction"/><link rel="apple-touch-icon" sizes="180x180" href="/images/favicon/baymax/apple-touch-icon.png"/><link rel="icon" type="image/png" href="/images/favicon/baymax/favicon-32x32.png" sizes="32x32"/><link rel="icon" type="image/png" href="/images/favicon/baymax/favicon-16x16.png" sizes="16x16"/><link rel="manifest" href="/images/favicon/baymax/manifest.json"/><script nonce="KGonNqmdinEb">window.manuallyNotifySentryOfError = function(event) { const randomValue = Math.random(); if (randomValue >= 0.01) { return; } window.disableManuallyNotifySentryOfError(); fetch("https:\u002F\u002Fo1061291.ingest.sentry.io\u002Fapi\u002F6173372\u002Fstore\u002F?sentry_key=154bcbb799a2437a9aec95856832798e", { method: 'POST', credentials: 'omit', body: JSON.stringify({ level: 'critical', timestamp: new Date().toJSON(), message: 'JS initialization error', environment: "production", release: "e5008d8b6d6bd98dc569e96c2d9b1478c37e09ea", user: {id: undefined}, tags: { deploymentGroup: (window.initData || {}).deploymentGroup, } }), }); }; window.disableManuallyNotifySentryOfError = function() { window.removeEventListener('error', window.manuallyNotifySentryOfError); window.removeEventListener('unhandledrejection', window.manuallyNotifySentryOfError); } window.addEventListener('error', window.manuallyNotifySentryOfError); window.addEventListener('unhandledrejection', window.manuallyNotifySentryOfError);</script><script nonce="KGonNqmdinEb">window.sentryConfiguration = {"codeVersion":"e5008d8b6d6bd98dc569e96c2d9b1478c37e09ea"};</script><script nonce="KGonNqmdinEb">window.initData = {"baseUrl":"https:\u002F\u002Fairtable.com","browserId":"brwMm4JAZYg7P2kgH","csrfToken":"fLXbLseF-n-VOWjzmvC2Remffqgx3yf6V3gE","enabledFeatureNames":["clipboardDataTransferPolicy","workflowsFormSubmittedTrigger","adminPanelIntegrationRestrictionGoogleDrive","externalTableSyncGoogleDrive","externalAccountsGoogleDrive","externalAccountsReconnectFlow","adminPanelIntegrationRestrictionSalesforce","adminPanelExternalSyncSources","workflowsHootsuiteSchedulePost","adminPanelIntegrationRestrictionHootsuite","externalAccountsHootsuite","externalTableSyncBox","adminPanelIntegrationRestrictionBox","externalAccountsBox","workflowsGoogleCalendarEventCancelledTrigger","workflowsDynamicallyTypedObject","workflowsSalesforceUpdateRecord","workflowsSalesforceCreateRecord","workflowsAtlassianJiraUpdateIssue","workflowsMicrosoftOutlookEventChangedTrigger","workflowsMicrosoftOutlookUpdateEvent","workflowsGoogleCalendarEventChangedTrigger","workflowsGoogleCalendarUpdateEvent","workflowsGenericWebhookReceivedTrigger","workflowsRenderRecords","newYearDiscount2021Rollout","testFixtureGeneratorApp","blocks.gantt.showHideWeekends","externalAccountsSalesforce","externalTableSyncSalesforce","externalTableSyncGoogleCalendar","externalTableSyncJira","externalSyncSources","adminPanelIntegrationRestrictionMicrosoftOutlookEmail","adminPanelIntegrationRestrictionMicrosoftOutlookCalendar","workflowsCronTrigger","blocks.sendSmsButtonAction","signupPageOverLockedProductBackgroundOverride","signupPageOverLockedProductBackground","disableAttachmentAnnotationsEnterpriseEarlyAccessMessage","devtoolsBlockDevelopment","workflowsEnableLookupsInExpressionBuilder","videoAttachmentAnnotationsEnterpriseEarlyAccess","workflowsFindRecordsAction","marketingNavRefresh","googleSheetsImport","attachmentAnnotations","blocks.csvImport.resetFieldMappings","blocks.gantt.useMilestones","seoTemplates","enterprisePricingSalesFormRedirectOverride","enterprisePricingSalesFormRedirect","migrationQuestionRollout","workflowsMicrosoftOutlookEventCreatedTrigger","workflowsMicrosoftOutlookCreateEvent","workflowsMicrosoftOutlookSendEmail","workflowsMicrosoftOutlookNewEmailTrigger","externalAccountsMicrosoftOutlookCalendar","externalAccountsMicrosoftOutlookEmail","apiCreateColumn","helpButtonInHeaderCopyExperimentSwitch","appleLoginButtonOnNonIosAppWebpages","isTrackPageViewPixelEnabled","iCalOnboardingTipExperimentRollout","iCalOnboardingTipExperimentOverride","isTrackPageViewSnippetEnabled","newTableTab","internationalFlatDiscountSeptember2020Rollout","excelImport","careersJobScamBanner","landingPageCtaCopyExperimentOverride","landingPageCtaCopyExperiment","tosAndPrivacyUpdate20200928","attachmentComments","blocksGalleryScripts","blocks.script.restrictEditing","crossBaseSyncPricingPage","workflowsFacebookPagesCreatePost","externalAccountsTwitter","externalAccountsFacebookPages","marketingMobileMenuReactRouterFix","thirdPartyBlocksEnterpriseRestriction","shouldShowAutoDetectSlider","platformContestAppsLaunchV1","blocks.appsRename","workflowsSendToSlackBotCustomizationInputs","blocksGalleryRefresh","highPromotionExperiment","onboardingPlanExplanation","adminPanelIntegrationRestrictionSettings","workflowsGoogleFormsNewResponseTrigger","workflowsGoogleCalendarEventTrigger","workflowsGoogleSheetsRowCreatedTrigger","workflowsRecordMatchesConditionsTrigger","apiCreateApplication","apiCreateTable","workflowsExpressionBuilder","blocks.map.randomWaitBeforeGeocoding","workflowsRecordUpdatedTrigger","workflowsAttachments","externalAccountsAtlassianJira","selectFieldColorLegend","workflowsTwitterPostTweet","workflowsAtlassianJiraCreateIssue","educationPlan","smbFlatDiscountAugust2020Rollout","viewSidebarV2","persistentHelpButtonExperimentOverride","viewSwitcherAsSidebar","dubiousTextFieldAll","selectMoleculeInGroupConfigExperimentApplyToOnlyNewUsers","blocks.mapsLocationUpdateDebounce","blocks.script.settings","onboardingSchedulingOverride","onboardingScheduling","workflowsProRollout","workflowsGoogleSheetsCreateRow","workflowsGoogleFormsCreateResponse","workflowsGoogleCalendarCreateEvent","workflowsGmailSendEmail","externalAccountsGoogleSheets","externalAccountsGoogleForms","externalAccountsGoogleCalendar","externalAccountsGmail","workspaceSharingOverride","workflowsTrash","showNewOnboardingQuestionnaireV2","workflowsDuplicate","videoAttachmentPreviews","editableSharedViewsInlineEditing","workflowsEnterpriseRollout","blocks.sdkMinimumVersionEnforcement","createLookupsFromColumnMenu","addRowButtonForComputedGroups","workflowsRecordCreatedTrigger","collapseRevisionHistoryInDetailViewExperimentOverride","blocks.pexelsButtonAction","blocks.formstackButtonAction","workflowsSendToMSTeamsAction","workflowsSendToSlackAction","externalAccounts","workflowsCustomScriptAction","blocks.customBlockButtonAction","emptyGroupsToggle","createViewBoxesControl","blocks.urlPreviewButtonAction","multiActionWorkflows","workflowsUpdateRecordAction","workflowsCreateRecordAction","sendEmailActionAdvancedInputs","blocks.scriptingButtonAction","blocks.sendgridButtonAction","blocks.pageDesignerButtonAction","collaboratorAttributionFields","showNewOnboardingQuestionnaireRollout","showHomescreenImportBannerRollout","blockDeveloperToolsOpenRecord","lookupMolecule","richTextLinkShortcuts","workflows","conditionalFormFields","conditionalRelationalColumns","updateEmailInAdminPanel","importLandingDialogExperiment","csvImportSize5MB","undoSnackbar","viewDescriptions","blockDescriptions","blocks.script.trackRestrictedGlobalAccess","multiShare","scriptingBlockDocs","enableBlockInstallationStats","showDiscountPromoExperimentRollout","billingDowngradeFormRequiredExperimentVariant","billingDowngradeFormRequiredExperimentRollout","blockDocs","blockInstallVerbExperiment","blockInstallationHostMethodCallTracker","foreignKeyNonreversed","attachmentsNonreversed","richTextAirtableFlavoredMarkdown","reactDatepickerDebounce","nonApplicationTrash","pageLoadEarlyPrefetch","reactDatePicker","enableBlockInstallationEventTracker","googleAnalyticsSegmentTracking","percentFieldV2","onboardingMainGoalQuestion","clientSideEventTracker","facebookPixelTracking","adRollTryTracking","twitterPixelTracking","analyticsIframeTracking","blocksUndo","onboardingV2","qualityOfServiceBeta","newAttachmentProcessor","hideInviteMessage","extraDocumentPreviews","disableBranchIos","accountRefresh","realtimeCompression","apiCellFormatString","iosFreezeNotificationsForPushRoutes","blockEditing","newBillingOnUpgrade","disableRollbarCaptureUnhandledRejections","workspaceOverPlanLimits"],"codeVersion":"e5008d8b6d6bd98dc569e96c2d9b1478c37e09ea","logFieldFormatVersion":"67df99a0da941d230de885af21ce33e5","pageLoadId":"pglR7C3H8yXbrdMuz","featureFlagConfigurationByFeatureName":{"testOnlyRolloutFlagWithInitialConfigState":{"precalculatedVariant":{"variant":"control","reason":"disabled"}},"demoOnlyGlobalFlag":{"precalculatedVariant":{"variant":"control","reason":"disabled"}},"androidInterface":{"precalculatedVariant":{"variant":"control","reason":"ineligibleFromRule","ruleType":"androidAppWithMinVersion"}},"androidInterfaceDashboard":{"precalculatedVariant":{"variant":"control","reason":"ineligibleFromRule","ruleType":"androidAppWithMinVersion"}},"androidInterfaceCalendarView":{"precalculatedVariant":{"variant":"control","reason":"ineligibleFromRule","ruleType":"androidAppWithMinVersion"}},"androidInterfaceCalendarWeekView":{"trafficLevel":100},"androidInterfaceConditionallyVisibleElements":{"trafficLevel":100},"androidInterfaceDropdownFilters":{"trafficLevel":100},"androidInterfaceGalleryView":{"precalculatedVariant":{"variant":"control","reason":"ineligibleFromRule","ruleType":"androidAppWithMinVersion"}},"androidInterfaceLevelsView":{"precalculatedVariant":{"variant":"control","reason":"ineligibleFromRule","ruleType":"androidAppWithMinVersion"}},"androidInterfaceAdvancedButtons":{"precalculatedVariant":{"variant":"control","reason":"ineligibleFromRule","ruleType":"androidAppWithMinVersion"}},"androidInterfaceKanbanView":{"precalculatedVariant":{"variant":"control","reason":"ineligibleFromRule","ruleType":"androidAppWithMinVersion"}},"androidInterfaceSharing":{"precalculatedVariant":{"variant":"control","reason":"ineligibleFromRule","ruleType":"androidAppWithMinVersion"}},"androidInterfaceChartAndNumberInRecordDetail":{"trafficLevel":100},"androidInterfaceConstrainedInbox":{"precalculatedVariant":{"variant":"control","reason":"ineligibleFromRule","ruleType":"androidAppWithMinVersion"}},"androidNativeComments":{"trafficLevel":100},"androidInterfaceEndUserNarrowing":{"precalculatedVariant":{"variant":"control","reason":"ineligibleFromRule","ruleType":"androidAppWithMinVersion"}},"androidInterfaceGridView":{"trafficLevel":100},"androidInterfaceOverviewLayout":{"trafficLevel":100},"androidCommentReactions":{"precalculatedVariant":{"variant":"control","reason":"ineligibleFromRule","ruleType":"androidAppWithMinVersion"}},"androidReadForPagesSchema24":{"precalculatedVariant":{"variant":"control","reason":"ineligibleFromRule","ruleType":"androidAppWithMinVersion"}},"androidNewHomescreenIA":{"trafficLevel":100},"androidShakeToSubmitFeedback":{"trafficLevel":0},"androidInterfaceTemplatesOnboarding":{"precalculatedVariant":{"variant":"control","reason":"ineligibleFromRule","ruleType":"androidAppWithMinVersion"}},"androidRestrictedLicenses":{"precalculatedVariant":{"variant":"control","reason":"ineligibleFromRule","ruleType":"androidAppWithMinVersion"}},"androidRichTextInLookupFields":{"precalculatedVariant":{"variant":"control","reason":"ineligibleFromRule","ruleType":"androidAppWithMinVersion"}},"androidDarkMode":{"trafficLevel":0},"canAiBeUsedOnEnterpriseAccountAsyncHipaaCheck":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"androidInterfaceAiGenerate":{"trafficLevel":100},"androidPivotTables":{"trafficLevel":0},"applicationIconsRefreshWeb":{"trafficLevel":100},"applicationIdPrefixedTableUrls":{"trafficLevel":100},"timelineElementImprovedSummariesPerf":{"trafficLevel":100},"interfaceDesignerCsvExportToggle":{"trafficLevel":100},"interfaceDesignerLinkedRecordContainersRecordTemplates":{"trafficLevel":0},"interfaceDesignerChartsGroupedBars":{"trafficLevel":100},"interfaceDesignerDeprecateRecordSummaryLayoutPreset":{"trafficLevel":100},"aggressiveForeignRowPickerCaching":{"trafficLevel":100},"canExecuteToolsOutsideCrudEndpoints":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"interfaceDesignerNavigateToPageWithSameRecordButton":{"trafficLevel":0},"interfaceDesignerEnableForeignRowCreateAtTheTopButtonStyle":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"pdfDataExtractionGaVisualTreatment":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"shouldUseHorizontalVirtualizationInLists":{"trafficLevel":100},"interfaceDesignerHomepageLayout":{"trafficLevel":100},"interfaceDesignerHomepageLayoutImage":{"trafficLevel":100},"interfaceDesignerHomepageLayoutFeatureAwareness":{"trafficLevel":0},"interfaceDesignerHomepageColoredBookmarks":{"trafficLevel":100},"interfaceDesignerMoveFilterByToDataInspector":{"trafficLevel":100,"winningVariant":"treatment"},"iosInterfaceAiGenerate":{"trafficLevel":0},"iosInterfaceComment":{"precalculatedVariant":{"variant":"control","reason":"ineligibleFromRule","ruleType":"iosAppWithMinVersion"}},"iosInterfaceConditionalGroups":{"precalculatedVariant":{"variant":"control","reason":"ineligibleFromRule","ruleType":"iosAppWithMinVersion"}},"iosInterfaceConstrainedInbox":{"precalculatedVariant":{"variant":"control","reason":"ineligibleFromRule","ruleType":"iosAppWithMinVersion"}},"iosFieldLevelTimeZone":{"trafficLevel":100},"iosInterface":{"trafficLevel":100},"iosInterfaceIpad":{"trafficLevel":0},"iosInterfaceShareDialog":{"precalculatedVariant":{"variant":"control","reason":"ineligibleFromRule","ruleType":"iosAppWithMinVersion"}},"iosInternalCustomization":{"trafficLevel":0},"iosReadForPagesSchema24":{"precalculatedVariant":{"variant":"control","reason":"ineligibleFromRule","ruleType":"iosAppWithMinVersion"}},"iosRestrictedLicenseVisualsAndEnforcement":{"precalculatedVariant":{"variant":"control","reason":"ineligibleFromRule","ruleType":"iosAppWithMinVersion"}},"iosShakeToSubmitFeedback":{"precalculatedVariant":{"variant":"control","reason":"ineligibleFromRule","ruleType":"internalUsers"}},"iosTwoWaySync":{"trafficLevel":100},"mobileHideContactSupportItem":{"precalculatedVariant":{"variant":"control","reason":"ineligibleFromRule","ruleType":"enterpriseAccountIds"}},"solutionSettings":{"trafficLevel":100},"interfaceDesignerFormButtonAction":{"trafficLevel":0},"interfaceDesignerDashboardConstrainedLayout":{"trafficLevel":100},"interfaceDesignerRecordDetailConstrainedLayout":{"trafficLevel":100},"interfaceDesignerRecordDetailAttachmentCarouseltHelperText":{"trafficLevel":100},"interfaceDesignerRecordDetailDefaultPermissions":{"trafficLevel":100},"interfaceDesignerRecordDetailConstrainedLayoutEscapeHatch":{"trafficLevel":100},"defaultDateFieldToNow":{"trafficLevel":100},"defaultsForCollaborator":{"trafficLevel":100},"uiBuilderInternalSettingsMenu":{"trafficLevel":0},"fullCanvasPageElementCreatorExperience":{"trafficLevel":0},"interfaceDesignerConstrainedInboxEndUserGrouping":{"trafficLevel":100},"interfaceDesignerAllowOldInboxLayout":{"trafficLevel":0},"interfaceDesignerLevelsHeaderCustomName":{"trafficLevel":100},"interfaceDesignerOnCanvasLevelsHeaderCustomName":{"trafficLevel":100},"interfaceDesignerCloseStandaloneForm":{"trafficLevel":100},"interfaceDesignerFormsTabAwareness":{"trafficLevel":100},"interfaceDesignerFormsTabNavigateToRecentForm":{"trafficLevel":100},"interfaceDesignerConstrainedLayoutButtonConfirmation":{"trafficLevel":100},"interfaceDesignerSurfacePageError":{"trafficLevel":100},"interfaceDesignerCheckReferenceRowPageLayout":{"trafficLevel":0},"interfaceDesignerBigNumberConditionalColor":{"trafficLevel":100},"interfaceDesignerBigNumberTealColor":{"trafficLevel":0},"darkModeInternalOnly":{"trafficLevel":0},"newUserOnboardingWithAiAppSetup":{"trafficLevel":100},"aiAppSetupLoggedInAdminFlagVariant":{"trafficLevel":0},"aiAppSetupInitializeEmptyAppBlanket":{"trafficLevel":100},"aiAppSetupCreateAppForDocs":{"trafficLevel":100},"aiAppSetupCreateAppForDocsUseHaikuForAllUsers":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"aiAppSetupCreateAppForDocsPreviewAllFilesForFreeAndTrial":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"aiAppSetupAiFieldUpsell":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"aiAppSetupComputedColumns":{"trafficLevel":20},"aiAppSetupComputedColumnsAiEnabledExperiment":{"trafficLevel":100},"aiAppSetupComputedColumnsAiDisabledExperiment":{"trafficLevel":0},"aiAppSetupComputedColumnsAiFieldUpsellExperiment":{"trafficLevel":0},"aiAppSetupInternalFeedbackForm":{"trafficLevel":0},"aiAppSetupAdvancedSettings":{"trafficLevel":0},"aiAppSetupBraintrustLogging":{"trafficLevel":100},"aiAppSetupLoggedOutPreviewBraintrustLogging":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"aiAppSetupNonPaidUserLimiting":{"trafficLevel":100},"aiAppSetupFeatureAwarenessCard":{"trafficLevel":100},"aiAppSetupImportFile":{"trafficLevel":100},"cobuilderCustomizationPageBuilderDashboard":{"trafficLevel":100},"cobuilderCustomizationPageBuilderLevels":{"trafficLevel":100},"cobuilderCustomizationPageBuilderTimeline":{"trafficLevel":0},"cobuilderCustomizationPageBuilderIterationDashboard":{"trafficLevel":0},"cobuilderCustomizationPageBuilderIterationLevels":{"trafficLevel":0},"cobuilderCustomizationWorkflowBuilder":{"trafficLevel":0},"cobuilderCustomizationComponentBundleBuilder":{"precalculatedVariant":{"variant":"control","reason":"disabled"}},"unifiedAiAssistantContainerEntrypoint":{"trafficLevel":100},"cobuilderCustomizationOptimizeForSummary":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"cobuilderCustomizationAiTextColumnsAsRelevantColumns":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"aiIssueInvoiceOnChangeToAiPlan":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"allowInstallingAiTemplateWithoutUpsell":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"sourcemaps":{"trafficLevel":0},"editableSharedViews":{"trafficLevel":0},"linkedRecordPickerDeferEnterOnLoading":{"trafficLevel":100},"templatesAllowWorkflowDuplication":{"trafficLevel":100},"homescreenWorkspacesFilterByOrgOrBillingPlan":{"trafficLevel":100},"blocksLogViewer":{"trafficLevel":0},"blockDeployServiceUseLambdaV3Client":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"blockRouterServiceUseLambdaV3Client":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"blocksV2":{"trafficLevel":0},"blockDashboardShowInteractionInterstitialsWithServerSpecifiedBlocks":{"trafficLevel":0},"blockDevCredentialsForCliBuild":{"trafficLevel":0},"blockDeveloperToolsFirstRun":{"trafficLevel":0},"blockEditingBackend":{"trafficLevel":0},"blockPublishing":{"trafficLevel":0},"doubleListRowsPageSize":{"trafficLevel":0},"extraHighZapierPageSizeLimit":{"trafficLevel":0},"highZapierPageSizeLimit":{"trafficLevel":0},"gridViewSummaryCellCopy":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"blocks.pageDesignerImportExport":{"trafficLevel":0},"customViewDevelopmentMode":{"precalculatedVariant":{"variant":"control","reason":"disabled"}},"blockInstallationLastReleaseTime":{"trafficLevel":0},"blockSyncingHiddenEndpoint":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"featureFlagInspector":{"trafficLevel":0},"internalDebugTools":{"trafficLevel":0},"clientSideConsoleLogging":{"trafficLevel":0},"clientSideTracing":{"trafficLevel":100},"blockAppsManagementUI":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"showBlocksUsageOnWorkspaceSettingsPage":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"blockInstallationLimitsExperiment":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"blockInstallationLimitsExperimentEnrollment":{"precalculatedVariant":{"variant":"control","reason":"disabled"}},"customerSuccessIntegrationEngineeringServicesCtaOnApiDocs":{"trafficLevel":0},"adminPanelReportForApiKeysAndTokens":{"trafficLevel":100},"blocksBackendLambdaNode18Runtime":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"appsToExtensionsRename":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"copilotInScriptBuilders":{"trafficLevel":0},"blockInstallationExposureTracker":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"blocksSharing":{"trafficLevel":0},"customBlocksSharing":{"trafficLevel":0},"packagesPlatformPackageCreatorRole":{"trafficLevel":0},"packagesPlatformFirstPartyPackageCreatorRole":{"trafficLevel":0},"packagesPlatformCustomPackageCreatorRole":{"trafficLevel":100},"packagesPlatformLibrary":{"trafficLevel":0},"packagesPlatform2PComponentsSetNameLocksAndDescriptionLocks":{"precalculatedVariant":{"variant":"control","reason":"disabled"}},"packagesPlatformLocalizePagePublishStatus":{"trafficLevel":100},"packagesPlatformUnlockWorkflowExternalAccountInputs":{"trafficLevel":100},"packagesPlatformUnlockWorkflowNotificationRecipientInputs":{"trafficLevel":100},"packagesPlatformAutomaticallyDeployNewlyCreatedAutomations":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"packagesPlatformPushUpdatesByEnterpriseAdmin":{"trafficLevel":0},"packagesPlatformAllowPublishedColumnTypeChange":{"trafficLevel":0},"packagesPlatformLibraryIncludeDatasetInfo":{"trafficLevel":0},"packagesPlatformLibraryManagementSurface":{"trafficLevel":100},"packagesPlatformLibraryManagementSurfaceCreatePackageFromExistingSchema":{"trafficLevel":100},"packagesPlatformLibraryResetAndUpdateOnConflicts":{"trafficLevel":100},"packagesPlatformEnforceBillingPlanChecks":{"trafficLevel":100},"packagesPlatformRestrictToEnterpriseScalePlan":{"trafficLevel":100},"packagesPlatformPopulateSubstitutionsOnPackageReleaseCreation":{"trafficLevel":0},"packagesPlatformAllowStandaloneColumnSubstitutionWhenInstalling":{"trafficLevel":0},"packagesPlatformAllowSubstitutionWhenInstalling":{"trafficLevel":0},"packagesPlatformEnableSuggestionsInSubstitutionUi":{"trafficLevel":0},"packagesPlatformInitializeFromExploreApplication":{"trafficLevel":100},"packagesPlatformEkmEncryptionForS3Data":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"packagesPlatformLockSuffixSectionsForConstrainedFormEntryPages":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"packagesPlatformNewFeatureBadgeInsteadOfBetaBadge":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"packagesPlatformIncludeScriptingAutomationTestResults":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"packagesPlatformIgnoreUnpublishedChangesToPublishedPages":{"trafficLevel":100},"packagesPlatformEnableEnterpriseAuditLogEvents":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"packagesPlatformCopyLimitOverridesFromDevelopmentBase":{"trafficLevel":100},"packagesPlatformRenameManagedApps":{"trafficLevel":100},"packagesPlatformAllowStandaloneFormPages":{"trafficLevel":100},"packagesPlatformBuilderHubUiRefresh":{"trafficLevel":100},"packagesPlatformAllowDuplicatingPackage":{"trafficLevel":100},"appOuterTrim":{"trafficLevel":100},"internalDocumentationShowLinksToInternalDocumentation":{"trafficLevel":0},"sandboxCreate":{"trafficLevel":0},"sandboxCreateInBackground":{"trafficLevel":100},"sandboxPublish":{"trafficLevel":0},"sandboxHomescreenDifferentiation":{"trafficLevel":0},"sandboxHomescreenDifferentiationMainApplications":{"trafficLevel":100},"aiOverCreditsEmailEnabled":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"aiFieldMatchingDebugStatistics":{"trafficLevel":0},"foreignKeyTimingStatistics":{"trafficLevel":100},"aiBedrockLlama3P1Availability":{"trafficLevel":100},"aiGenerateRecords":{"trafficLevel":0},"aiFormulaAssistantFeedback":{"trafficLevel":100},"aiBraintrustLogging":{"trafficLevel":100},"aiIncludeSensitiveDataInTraces":{"precalculatedVariant":{"variant":"control","reason":"disabled"}},"aiAssistantToolCallsDebug":{"trafficLevel":0},"aiInternetSearchGARollout":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"aiInternetSearchAdminSetting":{"trafficLevel":100},"aiInternetSearchAdminSettingGARollout":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"aiInternetReadWebpageInjectionBlock":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"aiInternetSearchHIPAACheck":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"aiAssistantBraintrustLogging":{"trafficLevel":100},"aiNewBillingAndOnboarding":{"trafficLevel":100},"aiLogOpenAIModerationResults":{"trafficLevel":100},"aiModerateOpenAiContent":{"trafficLevel":100},"upgradeNumberAndTextDefaults":{"trafficLevel":100},"sortLookupOrRollup":{"trafficLevel":0},"workflowsCustomScriptsUseLambdaMigrationPath":{"trafficLevel":100},"changeHookBasedWorkflowsOnlyIncludeColumnIdsNeededPerWorkflowGraph":{"trafficLevel":100},"outlookSendEmailPreventExternalClientRetriesInWes":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"jiraPreventExternalClientRetriesInWes":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"googlePreventExternalClientRetriesInWes":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"microsoftPreventExternalClientRetriesInWes":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"hootsuitePreventExternalClientRetriesInWes":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"twitterPreventExternalClientRetriesInWes":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"githubPreventExternalClientRetriesInWes":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"salesforcePreventExternalClientRetriesInWes":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"facebookPreventExternalClientRetriesInWes":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"runExternalTableSyncForSharedViewSourceInThread":{"trafficLevel":100},"runExternalTableSyncForEmailedCSVSourceInThread":{"trafficLevel":100},"jiraServerFavoriteFiltersErrorLogging":{"trafficLevel":0},"externalTableSyncGithubPullRequestsBranchName":{"trafficLevel":0},"externalTableSyncUseChangeHookToSkipNoOpsSyncForAirtableSharedViewSync":{"trafficLevel":100},"skipNoOpSyncDetectionByChangeHookForManualSync":{"trafficLevel":100},"invalidateSharedViewCachePriorToManualSync":{"trafficLevel":1},"externalTableSyncQueryChangeHookForAirtableSharedViewSync":{"trafficLevel":100},"externalTableSyncEnqueueIncrementalSyncOnChangeHookPingsForRealTimeSync":{"trafficLevel":100},"applicationChangeHooksOnUelEnableIncludeCellValuesFromFieldIdsBackfillForView":{"trafficLevel":100},"externalTableSyncRealTimeSyncDirectEnqueueFromChangeHookConsumer":{"trafficLevel":100},"externalTableSyncTableauServer":{"trafficLevel":0},"peopleTableMain":{"trafficLevel":0},"dangerouslyAllowPeopleTableManagement":{"trafficLevel":0},"externalAccountsTableauServer":{"trafficLevel":0},"enableRequestBodyLoggingExternalApi":{"trafficLevel":0},"adminPanelIntegrationRestrictionTableauServer":{"trafficLevel":0},"goldenDatasetsRelationshipMap":{"trafficLevel":0},"goldenDatasetsRelationshipMapUseYFilesAlgorithmAsDefault":{"trafficLevel":100},"baseEcosystemManagementInSupportPanel":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"externalAccountsAzureDevOps":{"trafficLevel":0},"azureDevOpsCreateWorkItemWorkflowAction":{"trafficLevel":0},"azureDevOpsUpdateWorkItemWorkflowAction":{"trafficLevel":0},"externalTableSyncAzureDevOps":{"trafficLevel":0},"externalAccountsTrayClearbit":{"precalculatedVariant":{"variant":"control","reason":"disabled"}},"adminPanelIntegrationRestrictionTrayClearbit":{"precalculatedVariant":{"variant":"control","reason":"disabled"}},"workflowsTrayClearbitCombinedByEmail":{"trafficLevel":0},"workflowsTrayClearbitCompanyByDomain":{"trafficLevel":0},"workflowsTrayClearbitPersonByEmail":{"trafficLevel":0},"attachmentSignatureV4":{"precalculatedVariant":{"variant":"control","reason":"disabled"}},"attachmentsAuthV3UserCookie":{"trafficLevel":0},"eudrAttachmentDeletionOfUsData":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"pdfTronAttachmentViewer":{"trafficLevel":0},"workflowsWebhookReceivedTriggerAutomaticallyTest":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"transformWorkflowToUseDynamicScopeFromBetaChangeHookSpecification":{"trafficLevel":100},"backfillEmptyChangeScopesInWorkflowChangeHookSpecification":{"trafficLevel":100},"applicationSearchForSmallBasesInThreads":{"trafficLevel":0},"applicationSearchForLargeBases":{"trafficLevel":100},"applicationShouldAlwaysUseRamIndexDirectoryLocationForSearch":{"trafficLevel":100},"applicationSearchUseRamDirectory":{"trafficLevel":100},"applicationSearchBrowserNativeOption":{"trafficLevel":0},"premiumIntegrationGatingEnforcement":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"workflowsDeprecateTwitterAction":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"workflowsDeprecateTrayActions":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"workflowsDisableClearbitActions":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"workflowsDisableTrayTwilioAction":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"dateDependenciesDisableRecalculation":{"trafficLevel":0},"dateDependenciesGAFeatureAwarenessCards":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"interfacesInEnterpriseApi":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"initialAaTestForClient":{"trafficLevel":50},"initialAaTestForLoggedInClient":{"trafficLevel":80},"initialAaTestForWeb":{"trafficLevel":100},"initialAaTestForWorkerChild":{"trafficLevel":90},"visitCookie":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"adminPanelEnforceMfaAdministeredUsers":{"trafficLevel":0},"adminPanelEnforceMfaExternalUsers":{"trafficLevel":0},"adminAssume":{"trafficLevel":100},"enterpriseHubMultiOrgMembership":{"trafficLevel":100},"enterpriseHubMembershipAllocationViaGroups":{"trafficLevel":100},"enterpriseHubEditGlobalAdmin":{"trafficLevel":0},"enterpriseHubRenameUnassignedOrgUnit":{"trafficLevel":0},"enterpriseOrganizationWideSharingAudience":{"trafficLevel":100},"enablePageBundleSharingAudienceEditPermissions":{"trafficLevel":100},"enterpriseHubPublicApiImprovements":{"trafficLevel":100},"enterpriseHubHomescreenOrgUnitMetadata":{"trafficLevel":100},"userGroupCollaboratorFiltering":{"trafficLevel":100},"stripeSendCorrectNameAndEmailWithCard":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"skilljarSSO":{"trafficLevel":100},"skilljarExpandedAccess":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"interfaceDesignerAutoSizeBigNumberValues":{"trafficLevel":100},"interfaceDesignerOnCanvasEditableSavedFilterSets":{"trafficLevel":0},"publiclySharedPageBundlePageFeatureAwarenessDismissButton":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"portalsAllowUpgradeWithPortalsAddOn":{"trafficLevel":0},"enablePortalsBetaBannerOnAccountPage":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"portalsCheckPortalAccessAcrossWorkspace":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"sessionExpiryUserFriendlyErrorMessage":{"trafficLevel":100},"sequentialCrudRequesterVerboseLoggingForUser":{"trafficLevel":0},"reassignPersonalView":{"trafficLevel":100},"alwaysInvoiceBusinessCheckouts":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"featureBasedUpsellExperiments2024":{"precalculatedVariant":{"variant":"control","reason":"disabled"}},"allowMultipleSamlCertsForRotations":{"precalculatedVariant":{"variant":"control","reason":"disabled"}},"viewerRestrictedLicenseUpgradeRequests":{"trafficLevel":100},"decoupleInitialLicenseAssignmentFromPermissionBasedCron":{"trafficLevel":0},"disableOrgUnitAdminLicenseAssignment":{"trafficLevel":100},"interfaceDesignerBuilderFeedbackButton":{"trafficLevel":100},"interfaceDesignerRename":{"trafficLevel":0},"featureKitInstallationLibraryExperiment":{"trafficLevel":100},"featureKitsInternalUser":{"trafficLevel":0},"disableObjectIdCloningWhenCloningApplication":{"trafficLevel":0},"bulkFieldEditPanelReduceFuzzySearchThreshold":{"precalculatedVariant":{"variant":"control","reason":"disabled"}},"updateExternalTableSyncSourceToTargetMapForBaseClone":{"trafficLevel":100},"interfaceDesignerFieldsListProperties":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"baseLevelMaintenanceMode":{"trafficLevel":0},"enterpriseAdminPanelBulkUpdateUserLicense":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"commentsAPI":{"trafficLevel":0},"commentsApiAllowAdminToUpdateComments":{"trafficLevel":0},"deleteApplicationAndWorkspaceApi":{"trafficLevel":100},"fetchDependencyUsageData":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"includeSyncTargetDeletionMetadata":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"unbilledTaxesMessagingInNullSubscriptionInvoiceEmail":{"precalculatedVariant":{"variant":"control","reason":"disabled"}},"billingAddOns":{"trafficLevel":100},"snapshotRestoreUnifiedEventLogEvents":{"trafficLevel":100},"snapshotRestoreUnifiedEventLogBlockDbCommits":{"trafficLevel":100},"cellHistoryRedactions":{"trafficLevel":0},"ekmAdminPanelSurfaces":{"trafficLevel":100},"enterpriseAuditLogCanAccessV1":{"trafficLevel":0},"createDataResidentEnterprise":{"trafficLevel":100},"claimListInviteRestriction":{"trafficLevel":100},"claimListShareRestriction":{"trafficLevel":100},"supportPanelBulkUpdateUserState":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"adminPanelGroupRoutes":{"trafficLevel":100},"premiumFormsForTrialUsers":{"trafficLevel":0},"multiStepLogin":{"trafficLevel":100},"inviteByFunctionCustomHeaderText":{"trafficLevel":100},"inviteByFunctionPredictCompanyNameInHeaderText":{"trafficLevel":100},"voiceCalls2faUserScoped":{"precalculatedVariant":{"variant":"control","reason":"disabled"}},"clearbitRevealIntegration":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"clearbitEnrichmentToGTM":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"genericMarketingABTest":{"trafficLevel":100,"winningVariant":"treatment"},"enableDriftWhenLoggedIn":{"precalculatedVariant":{"variant":"control","reason":"disabled"}},"genericMarketingMultivariateTest":{"precalculatedVariant":{"variant":"control","reason":"disabled"}},"enableHardRecordEnforcementServerSide":{"trafficLevel":100},"enableAttachmentLimitEnforcement":{"trafficLevel":100},"overPublicAPILimitNotificationExperiment":{"trafficLevel":50,"winningVariant":"treatment"},"categoryPickerOnMobile":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"productPageNewLinks":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"showOnboardingWizardToFirstTimeCreators":{"trafficLevel":100},"requireOnboardingFields":{"trafficLevel":100},"workspaceSettingsGracefullyHandleMissingApplicationOrPageBundle":{"trafficLevel":0},"teamsTrialRevamp2024":{"precalculatedVariant":{"variant":"control","reason":"disabled"}},"teamsTrialInProductUpsells":{"trafficLevel":100,"winningVariant":"treatment"},"pricingPageProductSolutionAddOn":{"trafficLevel":100},"showPublicApiUsageInWorkspaceSettings":{"trafficLevel":100,"winningVariant":"treatment"},"publicApiUsageDataKillswitch":{"precalculatedVariant":{"variant":"control","reason":"disabled"}},"skp2021SoftEnforceUserLimitsForFreePlan":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"workspaceSettingsManageSyncIntegrations":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"signupMagicLinksForMobileWeb":{"trafficLevel":100,"winningVariant":"control"},"signinMagicLinksRedirectWhenLoggedIn":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"fastAppSetupWizard":{"trafficLevel":100},"fastAppSetupWizardNewUserOnboardingExperiment":{"trafficLevel":100,"winningVariant":"treatment"},"promptShareExperimentCobuilder":{"trafficLevel":0},"promptShareExperimentInBase":{"trafficLevel":0},"improveCollaboratorFieldUsage":{"precalculatedVariant":{"variant":"control","reason":"disabled"}},"userOriginCountryFromIpAddressForSignup":{"trafficLevel":100},"biggerSignInWithAppleButton":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"disableWriteToLastOpenedWorkspacesOrApplicationDate":{"trafficLevel":100},"scheduledMaintenancePrompt":{"trafficLevel":0},"navigationRefreshV4":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"homepageBannerMarchLaunch":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"marketingHeaderBanner":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"newMarketingNavAug23":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"marketingPromoBannerEvent":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"marketingPromoBannerFeatureOrResource":{"precalculatedVariant":{"variant":"control","reason":"disabled"}},"disablePersonalizedContentInEmails":{"trafficLevel":100},"supportPanelOkta":{"trafficLevel":100},"supportPanelAccessRequests":{"trafficLevel":0},"perimeterX":{"trafficLevel":100},"perimeterXBlocking":{"trafficLevel":100},"cookieBannerSettingsButton":{"trafficLevel":100},"cookieBannerOnLoggedInPages":{"trafficLevel":100},"cookieBannerCallbackScript":{"trafficLevel":100},"clientSideProfilingForUser":{"trafficLevel":0},"realtimeShardAssignment":{"trafficLevel":0},"migrateQOSToFFv2":{"trafficLevel":0},"singleApplicationRealtimeClientVerboseLogging":{"trafficLevel":0},"singleApplicationRealtimeClientForceSockJSTransport":{"trafficLevel":0},"threadSafeStore":{"trafficLevel":100},"showElkLogLinksForErrors":{"trafficLevel":0},"appTransferCacheSidecar":{"trafficLevel":0},"appTransferCachePrimaryLoadIfSidecarEnabled":{"trafficLevel":0},"applicationHandoffCoordinator":{"trafficLevel":100},"forceEnableApplicationHandoffCoordinator":{"trafficLevel":0},"decoupleInitDataFromJsExecutionInLiveapp":{"trafficLevel":100},"routeWebRequestsToK8s":{"precalculatedVariant":{"variant":"control","reason":"disabled"}},"routeWebRequestsToDogfood":{"precalculatedVariant":{"variant":"control","reason":"ineligibleFromRule","ruleType":"internalUsers"}},"routeWebRequestsToEnterpriseHoldout":{"precalculatedVariant":{"variant":"control","reason":"ineligibleFromRule","ruleType":"enterpriseUsers"}},"showInternalLocales":{"trafficLevel":0},"showSpanishLocale":{"trafficLevel":100},"showLanguageChangeBanner":{"trafficLevel":100},"showSpanishLocaleForLoggedOutUsers":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}},"supportPanelCodeYellowBanner":{"precalculatedVariant":{"variant":"control","reason":"disabled"}},"dataTable":{"trafficLevel":0},"solutionsBrandingFallbackToFeatureKitInstallations":{"trafficLevel":100},"reactConcurrentRenderingRollout":{"trafficLevel":0},"microsoftOutlookAskForCalendarReadWriteSharedOAuthScope":{"trafficLevel":0},"autocompleteHideDeactivateUsers":{"precalculatedVariant":{"variant":"treatment","reason":"simpleFlag"}}},"adminFlagsForClient":{"TEST_ONLY_ADMIN_FLAG_FOR_CLIENT":3.14,"LARGE_VIEW_INTERSTITIAL_CELL_COUNT_THRESHOLD":500000,"LARGE_VIEW_INTERSTITIAL_SNOOZE_DURATION_HOURS":168,"MANUAL_FILTER_UPDATE_CELL_COUNT_THRESHOLD":500000,"MANUAL_FILTER_UPDATE_CONFIRMATION_THRESHOLD":10000,"AUTH_ATTACHMENT_V5_PERIODICALLY_CHECK_FOR_EXPIRING_URLS_INTERVAL_TIME_MS":600000,"HELP_SIDEBAR_CONFIG":{},"ADMIN_PANEL_DASHBOARD_DEPRECATION_DATE":"2023-05-15","THIRD_PARTY_UPLOAD_SOURCES_DEPRECATION_DATE":"2024-02-06","MAX_SOURCE_CELL_COUNT_FOR_ENABLING_TWO_WAY_SYNC":200000,"PACKAGES_PUSH_UPDATE_NUM_BASES_LIMIT_OVERRIDE":100,"SCHEDULED_MAINTENANCE_PROMPT":{"maintenanceType":"scheduledMaintenanceV20240117","allPrompts":[{"index":"0","heading":"Warning","description":"Your account will be deactivated at 21:00 pm GMT on January 31, 2024, since use of Airtable is not permitted in your region.","startTimestamp":"2024-01-17T00:00:00.000Z","endTimestamp":"2024-02-02T00:00:00.000Z","supportUrl":"https:\u002F\u002Fsupport.airtable.com\u002Fhc\u002Fen-us\u002Farticles\u002F4408864818839"}]},"ENTERPRISE_AUDIT_LOG_ARTIFICIAL_CUTOFF_DATE":"2023-04-01T00:00:00.000Z","FAST_APP_SETUP_DISABLE_ADD_ONS":false,"AI_AUTOMATIC_GENERATION_RECORD_COUNT_LIMIT":30000,"AI_BULK_GENERATION_RECORD_COUNT_LIMIT":30000,"AI_TOKENS_SCALING_FACTOR":1,"AI_MAX_DEPENDENT_COLUMNS_FOR_EMBEDDING_CONFIG":3,"AI_MAX_MATCHING_FIELDS_PER_BASE":24,"AI_MAX_SEMANTIC_SEARCH_EMBEDDING_CONFIGS_PER_BASE":55,"AI_MATCHING_EMBEDDING_THRESHOLD_PERCENT_TO_SKIP_IF_BELOW":80,"REALTIME_MAXIMUM_NUMBER_OF_RECONNECTION_ATTEMPTS":500,"CLIENT_LONG_TASK_PROFILING_PROBABILITY":0,"CLIENT_MIN_LONG_TASK_DURATION_TO_PROFILE_MS":1000,"WORKFLOW_FIND_RECORDS_MAX_RECORDS_LIMIT":1000,"WORKFLOW_FIND_RECORDS_CUSTOM_LIMIT_LAUNCH_TIMESTAMP":"2024-06-13T08:00:00.000Z","AI_APP_SETUP_NON_PAID_PREVIEW_LIMIT":5,"AI_APP_SETUP_PUBLIC_PREVIEW_AI_MODEL_SETTINGS_CONTROL_GROUP":{"model":"openAiChatGpt4o","temperature":0.4},"AI_APP_SETUP_PUBLIC_PREVIEW_AI_MODEL_SETTINGS_TREATMENT_GROUP":{"model":"openAiChatGpt4o","temperature":0.4},"AI_APP_SETUP_PUBLIC_PREVIEW_DATA_SCHEMA_WITH_EXAMPLES_AI_MODEL_SETTINGS_CONTROL_GROUP":{"model":"openAiChatGpt4o","temperature":0.4},"AI_APP_SETUP_PUBLIC_PREVIEW_DATA_SCHEMA_WITH_EXAMPLES_AI_MODEL_SETTINGS_TREATMENT_GROUP":{"model":"openAiChatGpt4o","temperature":0.4},"AI_APP_SETUP_LOGGED_IN_MODEL_OVERRIDES_TREATMENT_GROUP":{"overrides":[{"steps":["suggestAIColumnsFromAttachmentContents","extractInsightsFromDocument"],"model":"anthropicAtBedrockClaudeV3Haiku"}]},"AI_APP_SETUP_LOGGED_IN_MODEL_OVERRIDES_CONTROL_GROUP":null,"MAX_TOKENS_FOR_AI_FIELD_PREVIEW":100000,"AI_APP_SETUP_DISABLE_BRAINTRUST_LOGGING":false,"AI_APP_SETUP_MAX_CELL_VALUE_LENGTH_FOR_IMPORT":75,"AI_APP_SETUP_MAX_ROWS_PER_TABLE_FOR_IMPORT_PREVIEW":10,"AI_APP_SETUP_MAX_ROWS_PER_TABLE_FOR_IMPORT_PROMPT":5,"FEATURE_KIT_HIDDEN_VERSIONS":null,"TWO_WAY_SYNC_IGNORE_SAR_UPDATE":{"appEjAxiSX7eUit05":20000,"app0NtbEWTSBv1whJ":60000},"EMAIL_ROWS_MAX_NUM_RECIPIENTS":15,"DISABLE_BULK_AI_ATTACHMENT_OPERATIONS":false},"targetedUserIdForFeatureFlags":null,"pdftronApiKey":"Formagrid, Inc., dba Airtable:OEM:Airtable::B+:AMS(20241230):80A515BD0477580A0360B03AA982737160617F85AF56BD638DFD4D19955C08CE64AAB6F5C7","pdftronConfigUrl":"https:\u002F\u002Fstatic.airtable.com\u002Fesbuild\u002Fby_sha\u002Fe5008d8b\u002Fclient\u002Fcomponents\u002Fcolumn_types\u002Fmultiple_attachment\u002Fdocument_viewer\u002Fpdftron_webviewer_config\u002Fpdftron_webviewer_config_entrypoint.js","isMobile":false,"deploymentGroup":"stable","region":"us-east-1","openApi":{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{},"requestBodies":{},"responses":{},"schemas":{"Application-Permission-Levels":{"enum":["read","comment","edit","create"],"type":"string","x-airtable-name":"Application Permission Levels","x-airtable-tag":"collaborators"},"Audit-log":{"anyOf":[{"properties":{"createdByUserId":{"description":"A user ID","type":"string"},"createdTime":{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},"filter":{"description":"Filter specified in the [creation request](\u002Fapi\u002Fcreate-audit-log-request).","type":"string"},"id":{"type":"string"},"state":{"description":"The audit log request has not started processing or is being processed. Check again in a few minutes.","enum":["pending","processing"],"type":"string"},"timePeriod":{"description":"Either YYYY-MM or YYYY-MM-DD, as specified in the [creation request](\u002Fapi\u002Fcreate-audit-log-request).","type":"string"}},"required":["createdByUserId","createdTime","id","state","timePeriod"],"type":"object"},{"properties":{"createdByUserId":{"description":"A user ID","type":"string"},"createdTime":{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},"errorMessage":{"description":"An error message explaining what went wrong while processing the request.","type":"string"},"filter":{"description":"Filter specified in the [creation request](\u002Fapi\u002Fcreate-audit-log-request).","type":"string"},"id":{"type":"string"},"state":{"const":"error","description":"There was an error while attempting to process the audit log request.\nRefer to the error message and try again.","type":"string"},"timePeriod":{"description":"Either YYYY-MM or YYYY-MM-DD, as specified in the [creation request](\u002Fapi\u002Fcreate-audit-log-request).","type":"string"}},"required":["createdByUserId","createdTime","errorMessage","id","state","timePeriod"],"type":"object"},{"properties":{"createdByUserId":{"description":"A user ID","type":"string"},"createdTime":{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},"data":{"description":"Results from the finished audit log processing.","properties":{"expirationTime":{"description":"The URLs in **data.logFileUrls** expire after 7 days.","type":"string"},"logFileUrls":{"description":"URLs to audit log files.","items":{"type":"string"},"type":"array"}},"required":["logFileUrls","expirationTime"],"type":"object"},"filter":{"description":"Filter specified in the [creation request](\u002Fapi\u002Fcreate-audit-log-request).","type":"string"},"id":{"type":"string"},"state":{"const":"done","description":"The audit log request is done processing. Download the files in **data.logFileUrls**.\nThe gzipped files contain newline-delimited JSON log entries.\n\n`data` is uniquely provided with the `done` state","type":"string"},"timePeriod":{"description":"Either YYYY-MM or YYYY-MM-DD, as specified in the [creation request](\u002Fapi\u002Fcreate-audit-log-request).","type":"string"}},"required":["createdByUserId","createdTime","data","id","state","timePeriod"],"type":"object"}],"description":"A single \"audit log task\".\n\nThe keys common to all response types are `id`, `createdByUserId`, `createdTime`, `timePeriod`, `filter`","x-airtable-name":"Audit log","x-airtable-tag":"auditing"},"Audit-log-actor":{"anyOf":[{"properties":{"type":{"const":"user","type":"string"},"user":{"properties":{"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"}},"required":["id","email"],"type":"object"}},"required":["type","user"],"type":"object"},{"properties":{"type":{"const":"formSubmission","type":"string"},"viewId":{"type":"string"}},"required":["type","viewId"],"type":"object"},{"properties":{"automationId":{"type":"string"},"type":{"const":"automation","type":"string"}},"required":["type","automationId"],"type":"object"},{"properties":{"type":{"const":"system","type":"string"}},"required":["type"],"type":"object"},{"properties":{"type":{"const":"sync","type":"string"}},"required":["type"],"type":"object"},{"properties":{"type":{"const":"anonymousUser","type":"string"}},"required":["type"],"type":"object"},{"properties":{"type":{"const":"unknown","type":"string"}},"required":["type"],"type":"object"}],"x-airtable-name":"Audit log actor"},"Audit-log-event-payloads":{"additionalProperties":{},"type":"object","x-airtable-name":"Audit log event payloads","x-airtable-redirect-to-relative-path":"audit-log-event-types"},"Audit-log-event-types":{"enum":["createBase","deleteBase","moveBase","duplicateBase","viewBase","updateBaseName","updateBaseGuideText","restoreBaseFromSnapshot","restoreBaseFromTrash","enableShare","disableShare","configureShare","regenerateShare","viewShare","downloadAttachment","addBaseInviteLink","removeBaseInviteLink","configureBaseInviteLink","inviteBaseCollaborator","addBaseCollaborator","changeBaseInvitePermission","changeBaseCollaboratorPermission","removeBaseCollaborator","uninviteBaseCollaborator","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","addTwoFactorAuthenticationStrategy","removeTwoFactorAuthenticationStrategy","regenerateTwoFactorAuthenticationBackupCodes","setDefaultTwoFactorAuthenticationStrategy","disableTwoFactorAuthentication","createOauthAccessToken","refreshOauthAccessToken","grantEnterpriseAdminAccess","revokeEnterpriseAdminAccess","grantEnterpriseUpgraderAccess","revokeEnterpriseUpgraderAccess","updateEnterpriseName","deleteEnterpriseStripeCard","updateEnterpriseStripeCard","updateEnterprisePaymentMethod","updateEnterpriseInvoiceDetails","createOrgUnit","deleteOrgUnit","createEdiscoveryExport","updateSettingLock","updateOrgUnitConnection","changeEnterpriseInviteRestrictions","changeEnterpriseGlobalShareRestrictions","changeEnterpriseInterfaceOrgWideSharingRestrictions","changeEnterpriseGroupCreateRestrictions","changeEnterpriseIpAddressAccessRestrictions","changeEnterpriseExtensionConfigurationRestrictions","changeEnterpriseDataRetentionPolicy","changeEnterpriseAiRestrictionPolicy","changeEnterpriseMfaPolicy","changeEnterpriseLicenseUpgradeRequestConfig","changeDataTableInstallationRestrictions","changeEnterpriseColors","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","createWorkspace","deleteWorkspace","restoreWorkspaceFromTrash","moveWorkspace","changeWorkspaceSharingRestrictions","addWorkspaceInviteLink","configureWorkspaceInviteLink","removeWorkspaceInviteLink","updateWorkspaceName","changeWorkspaceAiPermissions","inviteWorkspaceCollaborator","addWorkspaceCollaborator","changeWorkspaceInvitePermission","changeWorkspaceCollaboratorPermission","removeWorkspaceCollaborator","uninviteWorkspaceCollaborator","viewInterface","deleteInterface","restoreInterfaceFromTrash","duplicateInterface","createInterface","updateInterfaceName","publishInterface","unpublishInterface","viewForm","publishForm","unpublishForm","configureFormSharingSettings","inviteInterfaceCollaborator","addInterfaceCollaborator","changeInterfaceInvitePermission","changeInterfaceCollaboratorPermission","removeInterfaceCollaborator","uninviteInterfaceCollaborator","configureInterfaceOrgWideSharing","downloadCSV","moderateAiContent","installSolution","updateSolutionVersion"],"type":"string","x-airtable-name":"Audit log event types","x-airtable-redirect-to-relative-path":"audit-log-event-types"},"Base-group-collaborator":{"allOf":[{"$ref":"#\u002Fcomponents\u002Fschemas\u002FGroup-Collaborator"},{"properties":{"baseId":{"description":"Base ID, a unique identifier for a base.","type":"string"}},"required":["baseId"],"type":"object"}],"unevaluatedProperties":false,"x-airtable-name":"Base group collaborator"},"Base-individual-collaborator":{"allOf":[{"$ref":"#\u002Fcomponents\u002Fschemas\u002FIndividual-Collaborator"},{"properties":{"baseId":{"description":"Base ID, a unique identifier for a base.","type":"string"}},"required":["baseId"],"type":"object"}],"unevaluatedProperties":false,"x-airtable-name":"Base individual collaborator"},"Base-invite-link":{"allOf":[{"$ref":"#\u002Fcomponents\u002Fschemas\u002FInvite-link"},{"properties":{"baseId":{"description":"Base ID, a unique identifier for a base.","type":"string"}},"required":["baseId"],"type":"object"}],"unevaluatedProperties":false,"x-airtable-name":"Base invite link"},"Cell-value":{"anyOf":[{"properties":{"isStale":{"description":"If the cell should be recomputed due to a dependency change.\nThis can either be a dependent field or the field configuration.","type":"boolean"},"state":{"description":"The current state of the cell.","enum":["empty","loading","generated"],"type":"string"},"value":{"description":"The value that is shown to the user inside of the cell","type":["string","null"]}},"required":["isStale","state","value"],"type":"object"},{"properties":{"errorType":{"description":"A short string that describes the error.","type":"string"},"isStale":{"description":"If the cell should be recomputed due to a dependency change.\nThis can either be a dependent field or the field configuration.","type":"boolean"},"state":{"const":"error","description":"Whether the cell is currently in an error state.","type":"string"},"value":{"description":"The value that is shown to the user inside of the cell","type":["string","null"]}},"required":["errorType","isStale","state","value"],"type":"object"},{"type":"number"},{"description":"The barcode object may contain the following two properties, both of which are optional.","properties":{"text":{"description":"Barcode data","type":"string"},"type":{"description":"Barcode symbology, e.g. \"upce\" or \"code39\"","type":["string","null"]}},"required":["text"],"type":"object"},{"description":"Object providing details about the button configuration.","properties":{"label":{"description":"Button label","type":"string"},"url":{"description":"For \"Open URL\" actions, the computed url value","type":["string","null"]}},"required":["label","url"],"type":"object"},{"const":true,"description":"This field is \"true\" when checked and otherwise empty.\n\nYou can write to the cell with \"false\", but the read value will be still be \"empty\" (unchecked).","type":"boolean"},{"type":"number"},{"type":"string"},{"type":"string"},{"anyOf":[{"type":"string"},{"type":"number"},{"const":true,"type":"boolean"},{"items":{"type":["string","number"]},"type":"array"}],"description":"Computed value - Check options.result to know the resulting field type."},{"description":"Multiple lines of text, which may contain \"mention tokens\", e.g.\n`\u003Cairtable:mention id=\"menE1i9oBaGX3DseR\"\u003E@Alex\u003C\u002Fairtable:mention\u003E`","type":"string"},{"items":{"properties":{"filename":{"description":"Filename, e.g. \"foo.jpg\"","type":"string"},"height":{"description":"Height, in pixels (these may be available if the attachment is an image)","type":"number"},"id":{"description":"Unique attachment id","type":"string"},"size":{"description":"File size, in bytes","type":"number"},"thumbnails":{"description":"These small, large, and full thumbnails may be available if attachment is an image or document","properties":{"full":{"properties":{"height":{"type":"number"},"url":{"description":"These may be available if the attachment is an image or document. See notes under `url` about the lifetime of these URLs.","type":"string"},"width":{"type":"number"}},"required":["url","width","height"],"type":"object"},"large":{"properties":{"height":{"type":"number"},"url":{"description":"These may be available if the attachment is an image or document. See notes under `url` about the lifetime of these URLs.","type":"string"},"width":{"type":"number"}},"required":["url","width","height"],"type":"object"},"small":{"properties":{"height":{"type":"number"},"url":{"description":"These may be available if the attachment is an image or document. See notes under `url` about the lifetime of these URLs.","type":"string"},"width":{"type":"number"}},"required":["url","width","height"],"type":"object"}},"type":"object"},"type":{"description":"Content type, e.g. \"image\u002Fjpeg\"","type":"string"},"url":{"description":"url, e.g. \"https:\u002F\u002Fv5.airtableusercontent.com\u002Ffoo\".\n\nURLs returned will expire 2 hours after being returned from our API.\nIf you want to persist the attachments, we recommend downloading them instead of saving the URL.\nSee [our support article](https:\u002F\u002Fsupport.airtable.com\u002Fdocs\u002Fairtable-attachment-url-behavior)\nfor more information.","type":"string"},"width":{"description":"Width, in pixels (these may be available if the attachment is an image)","type":"number"}},"required":["id","url","filename","size","type","width","height","thumbnails"],"type":"object"},"type":"array"},{"type":"number"},{"type":"number"},{"type":"number"},{"type":"number"},{"type":"string"},{"type":"number"},{"type":"string"},{"type":"string"},{"description":"Object providing details about the user collaborator in this field.","properties":{"email":{"description":"User's email address","type":"string"},"id":{"description":"User id or group id","type":"string"},"name":{"description":"User's display name (may be omitted if the user hasn't created an account)","type":"string"},"permissionLevel":{"description":"User's collaborator permission Level\n\nThis is only included if you're observing a webhooks response.","enum":["none","read","comment","edit","create"],"type":"string"},"profilePicUrl":{"description":"User's profile picture\n\nThis is only included if it exists for the user **and** you're observing a webhooks response.","type":"string"}},"required":["id"],"type":"object"},{"description":"Object providing details about the user collaborator in this field.","properties":{"email":{"description":"User's email address","type":"string"},"id":{"description":"User id or group id","type":"string"},"name":{"description":"User's display name (may be omitted if the user hasn't created an account)","type":"string"},"permissionLevel":{"description":"User's collaborator permission Level\n\nThis is only included if you're observing a webhooks response.","enum":["none","read","comment","edit","create"],"type":"string"},"profilePicUrl":{"description":"User's profile picture\n\nThis is only included if it exists for the user **and** you're observing a webhooks response.","type":"string"}},"required":["id"],"type":"object"},{"description":"Object providing details about the user collaborator in this field.","properties":{"email":{"description":"User's email address","type":"string"},"id":{"description":"User id or group id","type":"string"},"name":{"description":"User's display name (may be omitted if the user hasn't created an account)","type":"string"},"permissionLevel":{"description":"User's collaborator permission Level\n\nThis is only included if you're observing a webhooks response.","enum":["none","read","comment","edit","create"],"type":"string"},"profilePicUrl":{"description":"User's profile picture\n\nThis is only included if it exists for the user **and** you're observing a webhooks response.","type":"string"}},"required":["id"],"type":"object"},{"description":"The sync source name.","type":"string"},{"description":"Array of linked records IDs from the linked table.","items":{"description":"Record ID","type":"string"},"type":"array"},{"description":"Array of cell values from a field in the linked table.","items":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"boolean"},{}]},"type":"array"},{"items":{"description":"Object providing details about the user collaborator in this field.","properties":{"email":{"description":"User's email address","type":"string"},"id":{"description":"User id or group id","type":"string"},"name":{"description":"User's display name (may be omitted if the user hasn't created an account)","type":"string"},"permissionLevel":{"description":"User's collaborator permission Level\n\nThis is only included if you're observing a webhooks response.","enum":["none","read","comment","edit","create"],"type":"string"},"profilePicUrl":{"description":"User's profile picture\n\nThis is only included if it exists for the user **and** you're observing a webhooks response.","type":"string"}},"required":["id"],"type":"object"},"type":"array"},{"description":"Array of selected option names.","items":{"type":"string"},"type":"array"},{"type":"string"},{"type":"number"},{"const":true,"type":"boolean"},{"type":"string"}],"x-airtable-name":"Cell value","x-airtable-redirect-to-relative-path":"field-model"},"Cell-value-V2-by-fieldId":{"additionalProperties":{},"type":"object","x-airtable-name":"Cell value V2 by fieldId","x-airtable-redirect-to-relative-path":"field-model"},"Cell-value-V2-or-null-by-fieldId":{"additionalProperties":{},"type":"object","x-airtable-name":"Cell value V2 or null by fieldId","x-airtable-redirect-to-relative-path":"field-model"},"Change-events-actor":{"anyOf":[{"properties":{"type":{"const":"user","type":"string"},"user":{"properties":{"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"}},"required":["id","email"],"type":"object"}},"required":["type","user"],"type":"object"},{"properties":{"type":{"const":"formSubmission","type":"string"},"viewId":{"type":"string"}},"required":["type","viewId"],"type":"object"},{"properties":{"pageId":{"type":"string"},"type":{"const":"formPageSubmission","type":"string"}},"required":["type","pageId"],"type":"object"},{"properties":{"automationId":{"type":"string"},"type":{"const":"automation","type":"string"}},"required":["type","automationId"],"type":"object"},{"properties":{"type":{"const":"system","type":"string"}},"required":["type"],"type":"object"},{"properties":{"type":{"const":"sync","type":"string"}},"required":["type"],"type":"object"},{"properties":{"type":{"const":"anonymousUser","type":"string"}},"required":["type"],"type":"object"},{"properties":{"type":{"const":"unknown","type":"string"}},"required":["type"],"type":"object"}],"x-airtable-name":"Change events actor"},"Change-events-data":{"description":"Each **created\\***, **destroyed\\***, **changed\\*** field is optional.\n\nThis has a lot of overlap with the [Webhooks table changed](\u002Fapi\u002Fmodel\u002Fwebhooks-table-changed) model,\nhowever it does have a few properties not reported via webhooks, these are enumerated in\n[Change events table change](\u002Fapi\u002Fmodel\u002Fchange-events-table-change) and [Change events table create](\u002Fapi\u002Fmodel\u002Fchange-events-table-create).","properties":{"changedTablesById":{"additionalProperties":{"allOf":[{"$ref":"#\u002Fcomponents\u002Fschemas\u002FWebhooks-table-changed"},{"$ref":"#\u002Fcomponents\u002Fschemas\u002FChange-events-table-change"}],"unevaluatedProperties":false},"type":"object"},"createdTablesById":{"additionalProperties":{"allOf":[{"$ref":"#\u002Fcomponents\u002Fschemas\u002FWebhooks-table-created"},{"$ref":"#\u002Fcomponents\u002Fschemas\u002FChange-events-table-create"}],"unevaluatedProperties":false},"type":"object"},"destroyedTableIds":{"items":{"type":"string"},"type":"array"}},"type":"object","x-airtable-name":"Change events data"},"Change-events-table-change":{"description":"Table change data that is unique to change events. Generally combined with [webhooks table changed](\u002Fapi\u002Fmodel\u002Fwebhooks-table-changed).","properties":{"changedRecordsMetadataById":{"additionalProperties":{"properties":{"changedCommentsById":{"additionalProperties":{"properties":{"current":{"properties":{"text":{"description":"The comment text itself. Note that this can contain the user mentioned in the text.\nSee [user mentioned](\u002Fapi\u002Fmodel\u002Fuser-mentioned) for more.","type":"string"}},"required":["text"],"type":"object"},"previous":{"properties":{"text":{"description":"The comment text itself. Note that this can contain the user mentioned in the text.\nSee [user mentioned](\u002Fapi\u002Fmodel\u002Fuser-mentioned) for more.","type":"string"}},"required":["text"],"type":"object"}},"required":["current"],"type":"object"},"propertyNames":{"description":"A comment ID"},"type":"object"},"createdCommentsById":{"additionalProperties":{"properties":{"text":{"description":"The comment text itself. Note that this can contain the user mentioned in the text.\nSee [user mentioned](\u002Fapi\u002Fmodel\u002Fuser-mentioned) for more.","type":"string"}},"required":["text"],"type":"object"},"propertyNames":{"description":"A comment ID"},"type":"object"},"destroyedCommentIds":{"items":{"description":"A comment ID","type":"string"},"type":"array"}},"type":"object"},"propertyNames":{"description":"Record ID"},"type":"object"}},"type":"object","x-airtable-name":"Change events table change"},"Change-events-table-create":{"description":"Table creation data that is unique to change events. Generally combined with [webhooks table created](\u002Fapi\u002Fmodel\u002Fwebhooks-table-created).","properties":{"recordsMetadataById":{"additionalProperties":{"properties":{"commentsById":{"additionalProperties":{"properties":{"text":{"description":"The comment text itself. Note that this can contain the user mentioned in the text.\nSee [user mentioned](\u002Fapi\u002Fmodel\u002Fuser-mentioned) for more.","type":"string"}},"required":["text"],"type":"object"},"propertyNames":{"description":"A comment ID"},"type":"object"}},"type":"object"},"propertyNames":{"description":"Record ID"},"type":"object"}},"type":"object","x-airtable-name":"Change events table create"},"Collaborations":{"description":"Direct collaborations on the enterprise account's workspaces, bases and interfaces.","properties":{"baseCollaborations":{"items":{"properties":{"baseId":{"description":"Base ID, a unique identifier for a base.","type":"string"},"createdTime":{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},"grantedByUserId":{"description":"A user ID","type":"string"},"permissionLevel":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FApplication-Permission-Levels"}},"required":["baseId","permissionLevel","grantedByUserId","createdTime"],"type":"object"},"type":"array"},"interfaceCollaborations":{"items":{"properties":{"baseId":{"description":"Base ID, a unique identifier for a base.","type":"string"},"createdTime":{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},"grantedByUserId":{"description":"A user ID","type":"string"},"interfaceId":{"type":"string"},"permissionLevel":{"enum":["read","comment","edit"],"type":"string"}},"required":["interfaceId","baseId","permissionLevel","grantedByUserId","createdTime"],"type":"object"},"type":"array"},"workspaceCollaborations":{"items":{"properties":{"createdTime":{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},"grantedByUserId":{"description":"A user ID","type":"string"},"permissionLevel":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FWorkspace-Permission-Levels"},"workspaceId":{"type":"string"}},"required":["workspaceId","permissionLevel","grantedByUserId","createdTime"],"type":"object"},"type":"array"}},"required":["workspaceCollaborations","baseCollaborations","interfaceCollaborations"],"type":"object","x-airtable-name":"Collaborations"},"Field-Config":{"anyOf":[{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"type":{"const":"autoNumber","type":"string"}},"required":["name","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"type":{"const":"barcode","type":"string"}},"required":["name","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"type":{"const":"button","type":"string"}},"required":["name","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"options":{"properties":{"color":{"description":"The color of the checkbox.","enum":["greenBright","tealBright","cyanBright","blueBright","purpleBright","pinkBright","redBright","orangeBright","yellowBright","grayBright"],"type":"string"},"icon":{"description":"The icon name of the checkbox.","enum":["check","xCheckbox","star","heart","thumbsUp","flag","dot"],"type":"string"}},"required":["color","icon"],"type":"object"},"type":{"const":"checkbox","type":"string"}},"required":["name","options","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"type":{"const":"createdBy","type":"string"}},"required":["name","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"options":{"properties":{"result":{"anyOf":[{"properties":{"options":{"properties":{"dateFormat":{"properties":{"format":{"description":"`format` is always provided when reading.\n(`l` for local, `LL` for friendly, `M\u002FD\u002FYYYY` for us, `D\u002FM\u002FYYYY` for european, `YYYY-MM-DD` for iso)","enum":["l","LL","M\u002FD\u002FYYYY","D\u002FM\u002FYYYY","YYYY-MM-DD"],"type":"string"},"name":{"enum":["local","friendly","us","european","iso"],"type":"string"}},"required":["name","format"],"type":"object"}},"required":["dateFormat"],"type":"object"},"type":{"const":"date","type":"string"}},"required":["type","options"],"type":"object","x-airtable-name":"Date field config","x-airtable-redirect-to-relative-path":"field-model#dateonly"},{"properties":{"options":{"properties":{"dateFormat":{"properties":{"format":{"description":"`format` is always provided when reading.\n(`l` for local, `LL` for friendly, `M\u002FD\u002FYYYY` for us, `D\u002FM\u002FYYYY` for european, `YYYY-MM-DD` for iso)","enum":["l","LL","M\u002FD\u002FYYYY","D\u002FM\u002FYYYY","YYYY-MM-DD"],"type":"string"},"name":{"enum":["local","friendly","us","european","iso"],"type":"string"}},"required":["name","format"],"type":"object"},"timeFormat":{"properties":{"format":{"enum":["h:mma","HH:mm"],"type":"string"},"name":{"enum":["12hour","24hour"],"type":"string"}},"required":["name","format"],"type":"object"},"timeZone":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FTimezone"}},"required":["dateFormat","timeFormat","timeZone"],"type":"object"},"type":{"const":"dateTime","type":"string"}},"required":["type","options"],"type":"object","x-airtable-name":"Date-time field config","x-airtable-redirect-to-relative-path":"field-model#dateandtime"}],"description":"This will always be a `date` or `dateTime` field config."}},"type":"object"},"type":{"const":"createdTime","type":"string"}},"required":["name","options","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"options":{"properties":{"isValid":{"description":"`false` when recordLinkFieldId is null, e.g. the referenced column was deleted.","type":"boolean"},"recordLinkFieldId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["isValid"],"type":"object"},"type":{"const":"count","type":"string"}},"required":["name","options","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"options":{"properties":{"formula":{"description":"The formula including fields referenced by their IDs. For example, LEFT(4, {Birthday})\nin the Airtable.com formula editor will be returned as LEFT(4, {fldXXX}) via API.","type":"string"},"isValid":{"description":"`false` if the formula contains an error.","type":"boolean"},"referencedFieldIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"All fields in the record that are used in the formula."},"result":{"anyOf":[{"$ref":"#\u002Fcomponents\u002Fschemas\u002FField-type-and-options"},{"type":"null"}],"description":"The resulting field type and options returned by the formula. See other field\ntype configs on this page for the possible values. Can be null if invalid."}},"required":["isValid","formula","referencedFieldIds","result"],"type":"object"},"type":{"const":"formula","type":"string"}},"required":["name","options","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"options":{"properties":{"isValid":{"description":"False if this formula\u002Ffield configuation has an error","type":"boolean"},"referencedFieldIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"The fields to check the last modified time of"},"result":{"anyOf":[{"properties":{"options":{"properties":{"dateFormat":{"properties":{"format":{"description":"`format` is always provided when reading.\n(`l` for local, `LL` for friendly, `M\u002FD\u002FYYYY` for us, `D\u002FM\u002FYYYY` for european, `YYYY-MM-DD` for iso)","enum":["l","LL","M\u002FD\u002FYYYY","D\u002FM\u002FYYYY","YYYY-MM-DD"],"type":"string"},"name":{"enum":["local","friendly","us","european","iso"],"type":"string"}},"required":["name","format"],"type":"object"}},"required":["dateFormat"],"type":"object"},"type":{"const":"date","type":"string"}},"required":["type","options"],"type":"object","x-airtable-name":"Date field config","x-airtable-redirect-to-relative-path":"field-model#dateonly"},{"properties":{"options":{"properties":{"dateFormat":{"properties":{"format":{"description":"`format` is always provided when reading.\n(`l` for local, `LL` for friendly, `M\u002FD\u002FYYYY` for us, `D\u002FM\u002FYYYY` for european, `YYYY-MM-DD` for iso)","enum":["l","LL","M\u002FD\u002FYYYY","D\u002FM\u002FYYYY","YYYY-MM-DD"],"type":"string"},"name":{"enum":["local","friendly","us","european","iso"],"type":"string"}},"required":["name","format"],"type":"object"},"timeFormat":{"properties":{"format":{"enum":["h:mma","HH:mm"],"type":"string"},"name":{"enum":["12hour","24hour"],"type":"string"}},"required":["name","format"],"type":"object"},"timeZone":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FTimezone"}},"required":["dateFormat","timeFormat","timeZone"],"type":"object"},"type":{"const":"dateTime","type":"string"}},"required":["type","options"],"type":"object","x-airtable-name":"Date-time field config","x-airtable-redirect-to-relative-path":"field-model#dateandtime"},{"type":"null"}],"description":"This will always be a `date` or `dateTime` field config."}},"required":["isValid","referencedFieldIds","result"],"type":"object"},"type":{"const":"lastModifiedTime","type":"string"}},"required":["name","options","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"type":{"const":"lastModifiedBy","type":"string"}},"required":["name","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"options":{"properties":{"fieldIdInLinkedTable":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The field in the linked table that this field is looking up."},"isValid":{"description":"Is the field currently valid (e.g. false if the linked record field has\nbeen deleted)","type":"boolean"},"recordLinkFieldId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The linked record field in the current table."},"result":{"anyOf":[{"$ref":"#\u002Fcomponents\u002Fschemas\u002FField-type-and-options"},{"type":"null"}],"description":"The field type and options inside of the linked table. See other field\ntype configs on this page for the possible values. Can be null if invalid."}},"required":["isValid","recordLinkFieldId","fieldIdInLinkedTable","result"],"type":"object"},"type":{"const":"lookup","type":"string"}},"required":["name","options","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"options":{"properties":{"precision":{"description":"Indicates the number of digits shown to the right of the decimal point for this field. (0-8 inclusive)","type":"number"}},"required":["precision"],"type":"object"},"type":{"const":"number","type":"string"}},"required":["name","options","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"options":{"properties":{"precision":{"description":"Indicates the number of digits shown to the right of the decimal point for this field. (0-8 inclusive)","type":"number"}},"required":["precision"],"type":"object"},"type":{"const":"percent","type":"string"}},"required":["name","options","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"options":{"properties":{"precision":{"description":"Indicates the number of digits shown to the right of the decimal point for this field. (0-7 inclusive)","type":"number"},"symbol":{"description":"Currency symbol to use.","type":"string"}},"required":["precision","symbol"],"type":"object"},"type":{"const":"currency","type":"string"}},"required":["name","options","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"options":{"properties":{"durationFormat":{"enum":["h:mm","h:mm:ss","h:mm:ss.S","h:mm:ss.SS","h:mm:ss.SSS"],"type":"string"}},"required":["durationFormat"],"type":"object"},"type":{"const":"duration","type":"string"}},"required":["name","options","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"type":{"const":"multilineText","type":"string"}},"required":["name","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"type":{"const":"phoneNumber","type":"string"}},"required":["name","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"options":{"properties":{"color":{"description":"The color of selected icons.","enum":["yellowBright","orangeBright","redBright","pinkBright","purpleBright","blueBright","cyanBright","tealBright","greenBright","grayBright"],"type":"string"},"icon":{"description":"The icon name used to display the rating.","enum":["star","heart","thumbsUp","flag","dot"],"type":"string"},"max":{"description":"The maximum value for the rating, from 1 to 10 inclusive.","type":"number"}},"required":["color","icon","max"],"type":"object"},"type":{"const":"rating","type":"string"}},"required":["name","options","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"type":{"const":"richText","type":"string"}},"required":["name","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"options":{"properties":{"fieldIdInLinkedTable":{"description":"The id of the field in the linked table","type":"string"},"isValid":{"type":"boolean"},"recordLinkFieldId":{"description":"The linked field id","type":"string"},"referencedFieldIds":{"description":"The ids of any fields referenced in the rollup formula","items":{"type":"string"},"type":"array"},"result":{"anyOf":[{"$ref":"#\u002Fcomponents\u002Fschemas\u002FField-type-and-options"},{"type":"null"}],"description":"The resulting field type and options for the rollup. See other field\ntype configs on this page for the possible values. Can be null if invalid."}},"type":"object"},"type":{"const":"rollup","type":"string"}},"required":["name","options","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"type":{"const":"singleLineText","type":"string"}},"required":["name","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"type":{"const":"email","type":"string"}},"required":["name","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"type":{"const":"url","type":"string"}},"required":["name","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"options":{"properties":{"choices":{"items":{"properties":{"color":{"description":"Optional when the select field is configured to not use colors.\n\nAllowed values: \"blueLight2\", \"cyanLight2\", \"tealLight2\", \"greenLight2\", \"yellowLight2\", \"orangeLight2\", \"redLight2\", \"pinkLight2\", \"purpleLight2\", \"grayLight2\", \"blueLight1\", \"cyanLight1\", \"tealLight1\", \"greenLight1\", \"yellowLight1\", \"orangeLight1\", \"redLight1\", \"pinkLight1\", \"purpleLight1\", \"grayLight1\", \"blueBright\", \"cyanBright\", \"tealBright\", \"greenBright\", \"yellowBright\", \"orangeBright\", \"redBright\", \"pinkBright\", \"purpleBright\", \"grayBright\", \"blueDark1\", \"cyanDark1\", \"tealDark1\", \"greenDark1\", \"yellowDark1\", \"orangeDark1\", \"redDark1\", \"pinkDark1\", \"purpleDark1\", \"grayDark1\"","type":"string"},"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"type":"object"},"type":"array"}},"required":["choices"],"type":"object"},"type":{"const":"externalSyncSource","type":"string"}},"required":["name","options","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"options":{"properties":{"prompt":{"description":"The prompt that is used to generate the results in the AI field, additional object\ntypes may be added in the future. Currently, this is an array of strings or objects that identify any fields interpolated into the prompt.\n\nThe prompt will not currently be provided if this field config is within another\nfields configuration (like a lookup field)","items":{"anyOf":[{"type":"string"},{"properties":{"field":{"properties":{"fieldId":{"type":"string"}},"required":["fieldId"],"type":"object"}},"required":["field"],"type":"object"}]},"type":"array"},"referencedFieldIds":{"description":"The other fields in the record that are used in the ai field\n\nThe referencedFieldIds will not currently be provided if this field config is within another\nfields configuration (like a lookup field)","items":{"type":"string"},"type":"array"}},"type":"object"},"type":{"const":"aiText","type":"string"}},"required":["name","options","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"options":{"properties":{"linkedTableId":{"description":"The ID of the table this field links to","type":"string"},"viewIdForRecordSelection":{"description":"The ID of the view in the linked table\nto use when showing a list of records to select from","type":"string"}},"required":["linkedTableId"],"type":"object"},"type":{"const":"multipleRecordLinks","type":"string"}},"required":["name","options","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"options":{"properties":{"choices":{"items":{"properties":{"color":{"description":"Optional when creating an option.","type":"string"},"id":{"description":"This is not specified when creating new options, useful when specifing existing\noptions (for example: reordering options, keeping old options and adding new ones, etc)","type":"string"},"name":{"type":"string"}},"required":["name"],"type":"object"},"type":"array"}},"required":["choices"],"type":"object"},"type":{"const":"singleSelect","type":"string"}},"required":["name","options","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"options":{"properties":{"choices":{"items":{"properties":{"color":{"description":"Optional when creating an option.","type":"string"},"id":{"description":"This is not specified when creating new options, useful when specifing existing\noptions (for example: reordering options, keeping old options and adding new ones, etc)","type":"string"},"name":{"type":"string"}},"required":["name"],"type":"object"},"type":"array"}},"required":["choices"],"type":"object"},"type":{"const":"multipleSelects","type":"string"}},"required":["name","options","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"options":{"type":"object"},"type":{"const":"singleCollaborator","type":"string"}},"required":["name","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"options":{"type":"object"},"type":{"const":"multipleCollaborators","type":"string"}},"required":["name","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"options":{"properties":{"dateFormat":{"properties":{"format":{"description":"Format is optional when writing, but it must match\nthe corresponding name if provided.\n\n(`l` for local, `LL` for friendly, `M\u002FD\u002FYYYY` for us, `D\u002FM\u002FYYYY` for european, `YYYY-MM-DD` for iso)","enum":["l","LL","M\u002FD\u002FYYYY","D\u002FM\u002FYYYY","YYYY-MM-DD"],"type":"string"},"name":{"enum":["local","friendly","us","european","iso"],"type":"string"}},"required":["name"],"type":"object"}},"required":["dateFormat"],"type":"object"},"type":{"const":"date","type":"string"}},"required":["name","options","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"options":{"properties":{"dateFormat":{"properties":{"format":{"description":"Format is optional when writing, but it must match\nthe corresponding name if provided.\n\n(`l` for local, `LL` for friendly, `M\u002FD\u002FYYYY` for us, `D\u002FM\u002FYYYY` for european, `YYYY-MM-DD` for iso)","enum":["l","LL","M\u002FD\u002FYYYY","D\u002FM\u002FYYYY","YYYY-MM-DD"],"type":"string"},"name":{"enum":["local","friendly","us","european","iso"],"type":"string"}},"required":["name"],"type":"object"},"timeFormat":{"properties":{"format":{"enum":["h:mma","HH:mm"],"type":"string"},"name":{"enum":["12hour","24hour"],"type":"string"}},"required":["name"],"type":"object"},"timeZone":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FTimezone"}},"required":["dateFormat","timeFormat","timeZone"],"type":"object"},"type":{"const":"dateTime","type":"string"}},"required":["name","options","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"options":{"properties":{"isReversed":{"type":"boolean"}},"required":["isReversed"],"type":"object"},"type":{"const":"multipleAttachments","type":"string"}},"required":["name","type"],"type":"object"}],"description":"This identical to Field type and options, with\nan additional `name` and `description` property on all types","x-airtable-name":"Field Config","x-airtable-redirect-to-relative-path":"field-model"},"Field-Type":{"description":"These are all of the valid field types, see\n[here](\u002Fapi\u002Ffield-model) for more information.","enum":["singleLineText","email","url","multilineText","number","percent","currency","singleSelect","multipleSelects","singleCollaborator","multipleCollaborators","multipleRecordLinks","date","dateTime","phoneNumber","multipleAttachments","checkbox","formula","createdTime","rollup","count","lookup","multipleLookupValues","autoNumber","barcode","rating","richText","duration","lastModifiedTime","button","createdBy","lastModifiedBy","externalSyncSource","aiText"],"type":"string","x-airtable-name":"Field Type"},"Field-type-and-options":{"anyOf":[{"properties":{"type":{"const":"autoNumber","type":"string"}},"required":["type"],"type":"object"},{"properties":{"type":{"const":"barcode","type":"string"}},"required":["type"],"type":"object"},{"properties":{"type":{"const":"button","type":"string"}},"required":["type"],"type":"object"},{"description":"Bases on a free or plus plan are limited to using the `'check'` icon and `'greenBright'` color.","properties":{"options":{"properties":{"color":{"description":"The color of the checkbox.","enum":["greenBright","tealBright","cyanBright","blueBright","purpleBright","pinkBright","redBright","orangeBright","yellowBright","grayBright"],"type":"string"},"icon":{"description":"The icon name of the checkbox.","enum":["check","xCheckbox","star","heart","thumbsUp","flag","dot"],"type":"string"}},"required":["color","icon"],"type":"object"},"type":{"const":"checkbox","type":"string"}},"required":["type","options"],"type":"object"},{"properties":{"type":{"const":"createdBy","type":"string"}},"required":["type"],"type":"object"},{"properties":{"options":{"properties":{"result":{"anyOf":[{"properties":{"options":{"properties":{"dateFormat":{"properties":{"format":{"description":"`format` is always provided when reading.\n(`l` for local, `LL` for friendly, `M\u002FD\u002FYYYY` for us, `D\u002FM\u002FYYYY` for european, `YYYY-MM-DD` for iso)","enum":["l","LL","M\u002FD\u002FYYYY","D\u002FM\u002FYYYY","YYYY-MM-DD"],"type":"string"},"name":{"enum":["local","friendly","us","european","iso"],"type":"string"}},"required":["name","format"],"type":"object"}},"required":["dateFormat"],"type":"object"},"type":{"const":"date","type":"string"}},"required":["type","options"],"type":"object","x-airtable-name":"Date field config","x-airtable-redirect-to-relative-path":"field-model#dateonly"},{"properties":{"options":{"properties":{"dateFormat":{"properties":{"format":{"description":"`format` is always provided when reading.\n(`l` for local, `LL` for friendly, `M\u002FD\u002FYYYY` for us, `D\u002FM\u002FYYYY` for european, `YYYY-MM-DD` for iso)","enum":["l","LL","M\u002FD\u002FYYYY","D\u002FM\u002FYYYY","YYYY-MM-DD"],"type":"string"},"name":{"enum":["local","friendly","us","european","iso"],"type":"string"}},"required":["name","format"],"type":"object"},"timeFormat":{"properties":{"format":{"enum":["h:mma","HH:mm"],"type":"string"},"name":{"enum":["12hour","24hour"],"type":"string"}},"required":["name","format"],"type":"object"},"timeZone":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FTimezone"}},"required":["dateFormat","timeFormat","timeZone"],"type":"object"},"type":{"const":"dateTime","type":"string"}},"required":["type","options"],"type":"object","x-airtable-name":"Date-time field config","x-airtable-redirect-to-relative-path":"field-model#dateandtime"}],"description":"This will always be a `date` or `dateTime` field config."}},"type":"object"},"type":{"const":"createdTime","type":"string"}},"required":["type","options"],"type":"object"},{"properties":{"options":{"properties":{"isValid":{"description":"`false` when recordLinkFieldId is null, e.g. the referenced column was deleted.","type":"boolean"},"recordLinkFieldId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["isValid"],"type":"object"},"type":{"const":"count","type":"string"}},"required":["type","options"],"type":"object"},{"$ref":"#\u002Fcomponents\u002Fschemas\u002Falias-1510859713-1510859713"},{"properties":{"options":{"properties":{"isValid":{"description":"False if this formula\u002Ffield configuation has an error","type":"boolean"},"referencedFieldIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"The fields to check the last modified time of"},"result":{"anyOf":[{"properties":{"options":{"properties":{"dateFormat":{"properties":{"format":{"description":"`format` is always provided when reading.\n(`l` for local, `LL` for friendly, `M\u002FD\u002FYYYY` for us, `D\u002FM\u002FYYYY` for european, `YYYY-MM-DD` for iso)","enum":["l","LL","M\u002FD\u002FYYYY","D\u002FM\u002FYYYY","YYYY-MM-DD"],"type":"string"},"name":{"enum":["local","friendly","us","european","iso"],"type":"string"}},"required":["name","format"],"type":"object"}},"required":["dateFormat"],"type":"object"},"type":{"const":"date","type":"string"}},"required":["type","options"],"type":"object","x-airtable-name":"Date field config","x-airtable-redirect-to-relative-path":"field-model#dateonly"},{"properties":{"options":{"properties":{"dateFormat":{"properties":{"format":{"description":"`format` is always provided when reading.\n(`l` for local, `LL` for friendly, `M\u002FD\u002FYYYY` for us, `D\u002FM\u002FYYYY` for european, `YYYY-MM-DD` for iso)","enum":["l","LL","M\u002FD\u002FYYYY","D\u002FM\u002FYYYY","YYYY-MM-DD"],"type":"string"},"name":{"enum":["local","friendly","us","european","iso"],"type":"string"}},"required":["name","format"],"type":"object"},"timeFormat":{"properties":{"format":{"enum":["h:mma","HH:mm"],"type":"string"},"name":{"enum":["12hour","24hour"],"type":"string"}},"required":["name","format"],"type":"object"},"timeZone":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FTimezone"}},"required":["dateFormat","timeFormat","timeZone"],"type":"object"},"type":{"const":"dateTime","type":"string"}},"required":["type","options"],"type":"object","x-airtable-name":"Date-time field config","x-airtable-redirect-to-relative-path":"field-model#dateandtime"},{"type":"null"}],"description":"This will always be a `date` or `dateTime` field config."}},"required":["isValid","referencedFieldIds","result"],"type":"object"},"type":{"const":"lastModifiedTime","type":"string"}},"required":["type","options"],"type":"object"},{"properties":{"type":{"const":"lastModifiedBy","type":"string"}},"required":["type"],"type":"object"},{"properties":{"options":{"properties":{"fieldIdInLinkedTable":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The field in the linked table that this field is looking up."},"isValid":{"description":"Is the field currently valid (e.g. false if the linked record field has\nbeen deleted)","type":"boolean"},"recordLinkFieldId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The linked record field in the current table."},"result":{"anyOf":[{"$ref":"#\u002Fcomponents\u002Fschemas\u002FField-type-and-options"},{"type":"null"}],"description":"The field type and options inside of the linked table. See other field\ntype configs on this page for the possible values. Can be null if invalid."}},"required":["isValid","recordLinkFieldId","fieldIdInLinkedTable","result"],"type":"object"},"type":{"const":"lookup","type":"string"}},"required":["type","options"],"type":"object"},{"properties":{"options":{"properties":{"precision":{"description":"Indicates the number of digits shown to the right of the decimal point for this field. (0-8 inclusive)","type":"number"}},"required":["precision"],"type":"object"},"type":{"const":"number","type":"string"}},"required":["type","options"],"type":"object"},{"properties":{"options":{"properties":{"precision":{"description":"Indicates the number of digits shown to the right of the decimal point for this field. (0-8 inclusive)","type":"number"}},"required":["precision"],"type":"object"},"type":{"const":"percent","type":"string"}},"required":["type","options"],"type":"object"},{"properties":{"options":{"properties":{"precision":{"description":"Indicates the number of digits shown to the right of the decimal point for this field. (0-7 inclusive)","type":"number"},"symbol":{"description":"Currency symbol to use.","type":"string"}},"required":["precision","symbol"],"type":"object"},"type":{"const":"currency","type":"string"}},"required":["type","options"],"type":"object"},{"properties":{"options":{"properties":{"durationFormat":{"enum":["h:mm","h:mm:ss","h:mm:ss.S","h:mm:ss.SS","h:mm:ss.SSS"],"type":"string"}},"required":["durationFormat"],"type":"object"},"type":{"const":"duration","type":"string"}},"required":["type","options"],"type":"object"},{"properties":{"type":{"const":"multilineText","type":"string"}},"required":["type"],"type":"object"},{"properties":{"type":{"const":"phoneNumber","type":"string"}},"required":["type"],"type":"object"},{"description":"Bases on a free or plus plan are limited to using the 'star' icon and 'yellowBright' color.","properties":{"options":{"properties":{"color":{"description":"The color of selected icons.","enum":["yellowBright","orangeBright","redBright","pinkBright","purpleBright","blueBright","cyanBright","tealBright","greenBright","grayBright"],"type":"string"},"icon":{"description":"The icon name used to display the rating.","enum":["star","heart","thumbsUp","flag","dot"],"type":"string"},"max":{"description":"The maximum value for the rating, from 1 to 10 inclusive.","type":"number"}},"required":["color","icon","max"],"type":"object"},"type":{"const":"rating","type":"string"}},"required":["type","options"],"type":"object"},{"properties":{"type":{"const":"richText","type":"string"}},"required":["type"],"type":"object"},{"properties":{"options":{"properties":{"fieldIdInLinkedTable":{"description":"The id of the field in the linked table","type":"string"},"isValid":{"type":"boolean"},"recordLinkFieldId":{"description":"The linked field id","type":"string"},"referencedFieldIds":{"description":"The ids of any fields referenced in the rollup formula","items":{"type":"string"},"type":"array"},"result":{"anyOf":[{"$ref":"#\u002Fcomponents\u002Fschemas\u002FField-type-and-options"},{"type":"null"}],"description":"The resulting field type and options for the rollup. See other field\ntype configs on this page for the possible values. Can be null if invalid."}},"type":"object"},"type":{"const":"rollup","type":"string"}},"required":["type","options"],"type":"object"},{"properties":{"type":{"const":"singleLineText","type":"string"}},"required":["type"],"type":"object"},{"properties":{"type":{"const":"email","type":"string"}},"required":["type"],"type":"object"},{"properties":{"type":{"const":"url","type":"string"}},"required":["type"],"type":"object"},{"properties":{"options":{"properties":{"choices":{"items":{"properties":{"color":{"description":"Optional when the select field is configured to not use colors.\n\nAllowed values: \"blueLight2\", \"cyanLight2\", \"tealLight2\", \"greenLight2\", \"yellowLight2\", \"orangeLight2\", \"redLight2\", \"pinkLight2\", \"purpleLight2\", \"grayLight2\", \"blueLight1\", \"cyanLight1\", \"tealLight1\", \"greenLight1\", \"yellowLight1\", \"orangeLight1\", \"redLight1\", \"pinkLight1\", \"purpleLight1\", \"grayLight1\", \"blueBright\", \"cyanBright\", \"tealBright\", \"greenBright\", \"yellowBright\", \"orangeBright\", \"redBright\", \"pinkBright\", \"purpleBright\", \"grayBright\", \"blueDark1\", \"cyanDark1\", \"tealDark1\", \"greenDark1\", \"yellowDark1\", \"orangeDark1\", \"redDark1\", \"pinkDark1\", \"purpleDark1\", \"grayDark1\"","type":"string"},"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"type":"object"},"type":"array"}},"required":["choices"],"type":"object"},"type":{"const":"externalSyncSource","type":"string"}},"required":["type","options"],"type":"object"},{"properties":{"options":{"properties":{"prompt":{"description":"The prompt that is used to generate the results in the AI field, additional object\ntypes may be added in the future. Currently, this is an array of strings or objects that identify any fields interpolated into the prompt.\n\nThe prompt will not currently be provided if this field config is within another\nfields configuration (like a lookup field)","items":{"anyOf":[{"type":"string"},{"properties":{"field":{"properties":{"fieldId":{"type":"string"}},"required":["fieldId"],"type":"object"}},"required":["field"],"type":"object"}]},"type":"array"},"referencedFieldIds":{"description":"The other fields in the record that are used in the ai field\n\nThe referencedFieldIds will not currently be provided if this field config is within another\nfields configuration (like a lookup field)","items":{"type":"string"},"type":"array"}},"type":"object"},"type":{"const":"aiText","type":"string"}},"required":["type","options"],"type":"object"},{"description":"Creating \"multipleRecordLinks\" fields is supported but updating options for\nexisting \"multipleRecordLinks\" fields is not supported.","properties":{"options":{"properties":{"linkedTableId":{"description":"The ID of the table this field links to","type":"string"},"viewIdForRecordSelection":{"description":"The ID of the view in the linked table\nto use when showing a list of records to select from","type":"string"}},"required":["linkedTableId"],"type":"object"},"type":{"const":"multipleRecordLinks","type":"string"}},"required":["type","options"],"type":"object"},{"properties":{"options":{"properties":{"choices":{"items":{"properties":{"color":{"description":"Optional when creating an option.","type":"string"},"id":{"description":"This is not specified when creating new options, useful when specifing existing\noptions (for example: reordering options, keeping old options and adding new ones, etc)","type":"string"},"name":{"type":"string"}},"required":["name"],"type":"object"},"type":"array"}},"required":["choices"],"type":"object"},"type":{"const":"singleSelect","type":"string"}},"required":["options","type"],"type":"object"},{"properties":{"options":{"properties":{"choices":{"items":{"properties":{"color":{"description":"Optional when creating an option.","type":"string"},"id":{"description":"This is not specified when creating new options, useful when specifing existing\noptions (for example: reordering options, keeping old options and adding new ones, etc)","type":"string"},"name":{"type":"string"}},"required":["name"],"type":"object"},"type":"array"}},"required":["choices"],"type":"object"},"type":{"const":"multipleSelects","type":"string"}},"required":["options","type"],"type":"object"},{"properties":{"options":{"type":"object"},"type":{"const":"singleCollaborator","type":"string"}},"required":["type"],"type":"object"},{"properties":{"options":{"type":"object"},"type":{"const":"multipleCollaborators","type":"string"}},"required":["type"],"type":"object"},{"properties":{"options":{"properties":{"dateFormat":{"properties":{"format":{"description":"Format is optional when writing, but it must match\nthe corresponding name if provided.\n\n(`l` for local, `LL` for friendly, `M\u002FD\u002FYYYY` for us, `D\u002FM\u002FYYYY` for european, `YYYY-MM-DD` for iso)","enum":["l","LL","M\u002FD\u002FYYYY","D\u002FM\u002FYYYY","YYYY-MM-DD"],"type":"string"},"name":{"enum":["local","friendly","us","european","iso"],"type":"string"}},"required":["name"],"type":"object"}},"required":["dateFormat"],"type":"object"},"type":{"const":"date","type":"string"}},"required":["type","options"],"type":"object"},{"properties":{"options":{"properties":{"dateFormat":{"properties":{"format":{"description":"Format is optional when writing, but it must match\nthe corresponding name if provided.\n\n(`l` for local, `LL` for friendly, `M\u002FD\u002FYYYY` for us, `D\u002FM\u002FYYYY` for european, `YYYY-MM-DD` for iso)","enum":["l","LL","M\u002FD\u002FYYYY","D\u002FM\u002FYYYY","YYYY-MM-DD"],"type":"string"},"name":{"enum":["local","friendly","us","european","iso"],"type":"string"}},"required":["name"],"type":"object"},"timeFormat":{"properties":{"format":{"enum":["h:mma","HH:mm"],"type":"string"},"name":{"enum":["12hour","24hour"],"type":"string"}},"required":["name"],"type":"object"},"timeZone":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FTimezone"}},"required":["dateFormat","timeFormat","timeZone"],"type":"object"},"type":{"const":"dateTime","type":"string"}},"required":["type","options"],"type":"object"},{"properties":{"options":{"properties":{"isReversed":{"type":"boolean"}},"required":["isReversed"],"type":"object"},"type":{"const":"multipleAttachments","type":"string"}},"required":["type"],"type":"object"}],"x-airtable-name":"Field type and options","x-airtable-redirect-to-relative-path":"field-model"},"Group-Collaborator":{"properties":{"createdTime":{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},"grantedByUserId":{"description":"A user ID","type":"string"},"groupId":{"description":"A user group ID","type":"string"},"name":{"type":"string"},"permissionLevel":{"enum":["none","read","comment","edit","create","owner"],"type":"string"}},"required":["groupId","name","permissionLevel","createdTime","grantedByUserId"],"type":"object","x-airtable-name":"Group Collaborator","x-airtable-tag":"collaborators"},"Individual-Collaborator":{"properties":{"createdTime":{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},"email":{"type":"string"},"grantedByUserId":{"description":"A user ID","type":"string"},"permissionLevel":{"enum":["none","read","comment","edit","create","owner"],"type":"string"},"userId":{"description":"A user ID","type":"string"}},"required":["userId","email","permissionLevel","createdTime","grantedByUserId"],"type":"object","x-airtable-name":"Individual Collaborator","x-airtable-tag":"collaborators"},"Invite-link":{"description":"Represents a single or multiuse invite link.","properties":{"createdTime":{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},"id":{"type":"string"},"invitedEmail":{"description":"May be null for multiUse invites.","type":["string","null"]},"permissionLevel":{"enum":["none","read","comment","edit","create","owner"],"type":"string"},"referredByUserId":{"description":"A user ID","type":"string"},"restrictedToEmailDomains":{"description":"If an empty list, no restrictions are present.\nElse, a receiver must have an email domain within the list to claim the invite.","items":{"type":"string"},"type":"array"},"type":{"enum":["singleUse","multiUse"],"type":"string"}},"required":["id","type","invitedEmail","restrictedToEmailDomains","permissionLevel","createdTime","referredByUserId"],"type":"object","x-airtable-name":"Invite link"},"SCIM-user-schema":{"description":"[SCIM User](https:\u002F\u002Fdatatracker.ietf.org\u002Fdoc\u002Fhtml\u002Frfc7643#section-4.1) objects with optional user metadata.\n\nSee [SCIM Field Types](\u002Fapi\u002Fscim-overview#scim-user-objects) for more information about optional\nuser metadata.","properties":{"active":{"description":"Indicates if the user is active or deactivated.\n\nSetting this is possible via the put and patch endpoints.","type":["boolean","null"]},"addresses":{"anyOf":[{"items":{"properties":{"country":{"type":["string","null"]},"formatted":{"type":["string","null"]},"locality":{"type":["string","null"]},"postalCode":{"type":["string","null"]},"primary":{"type":["boolean","null"]},"region":{"type":["string","null"]},"streetAddress":{"type":["string","null"]},"type":{"enum":["work","home","other",null],"type":["string","null"]}},"type":"object"},"type":"array"},{"type":"null"}]},"displayName":{"type":["string","null"]},"emails":{"anyOf":[{"items":{"properties":{"display":{"type":["string","null"]},"primary":{"type":["boolean","null"]},"type":{"type":["string","null"]},"value":{"type":"string"}},"required":["value"],"type":"object"},"type":"array"},{"type":"null"}]},"entitlements":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}]},"externalId":{"description":"Provisioning client defined identifier.","type":["string","null"]},"groups":{"anyOf":[{"items":{"properties":{"$ref":{"type":["string","null"]},"value":{"type":"string"}},"required":["value"],"type":"object"},"type":"array"},{"type":"null"}]},"id":{"description":"Airtable's unique user ID for this user.","type":"string"},"ims":{"anyOf":[{"items":{"properties":{"display":{"type":["string","null"]},"primary":{"type":["boolean","null"]},"type":{"type":["string","null"]},"value":{"type":"string"}},"required":["value"],"type":"object"},"type":"array"},{"type":"null"}]},"locale":{"type":["string","null"]},"meta":{},"name":{"anyOf":[{"properties":{"familyName":{"description":"Becomes the \"lastName\" field in Airtable.","type":["string","null"]},"formatted":{"type":["string","null"]},"givenName":{"description":"Becomes the \"firstName\" field in Airtable.","type":["string","null"]},"honorificPrefix":{"type":["string","null"]},"honorificSuffix":{"type":["string","null"]},"middleName":{"type":["string","null"]}},"type":"object"},{"type":"null"}]},"nickName":{"type":["string","null"]},"password":{"type":["string","null"]},"phoneNumbers":{"anyOf":[{"items":{"properties":{"display":{"type":["string","null"]},"primary":{"type":["boolean","null"]},"type":{"type":["string","null"]},"value":{"type":"string"}},"required":["value"],"type":"object"},"type":"array"},{"type":"null"}]},"photos":{"anyOf":[{"items":{"properties":{"primary":{"type":["boolean","null"]},"type":{"enum":["photo","thumbnail",null],"type":["string","null"]},"value":{"type":"string"}},"required":["value"],"type":"object"},"type":"array"},{"type":"null"}]},"preferredLanguage":{"type":["string","null"]},"profileUrl":{"type":["string","null"]},"roles":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}]},"schemas":{"description":"A list of schemas, including at least SCIM's core user schema URI.\n\nYou can add the [enterprise extension](https:\u002F\u002Fdatatracker.ietf.org\u002Fdoc\u002Fhtml\u002Frfc7643#section-4.3)\nschema URI if you want to send extra properties for reporting.\n\nSee the optional user metadata table for details.","items":{"type":"string"},"type":"array"},"timezone":{"type":["string","null"]},"title":{"type":["string","null"]},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"anyOf":[{"properties":{"costCenter":{"type":["string","null"]},"department":{"type":["string","null"]},"division":{"type":["string","null"]},"employeeNumber":{"type":["string","null"]},"manager":{"anyOf":[{"properties":{"$ref":{"type":["string","null"]},"displayName":{"type":["string","null"]},"value":{"type":["string","null"]}},"type":"object"},{"type":"null"}]},"organization":{"type":["string","null"]}},"type":"object"},{"type":"null"}],"description":"Custom extension, see [SCIM Field Types](\u002Fapi\u002Fscim-overview#scim-user-objects) for more"},"userName":{"description":"Becomes the \"email\" field in Airtable. It must not be in use already, and\nthe email's domain must match the enterprise account.","type":"string"},"userType":{"type":["string","null"]}},"required":["schemas","userName"],"type":"object","x-airtable-name":"SCIM user schema","x-airtable-tag":"scim"},"Scope":{"enum":["data.records:read","data.records:write","data.records:manage","data.recordComments:read","data.recordComments:write","enterprise.usersAndGroups:manage","enterprise.scim.usersAndGroups:manage","schema.bases:read","schema.bases:write","enterprise.auditLogs:read","enterprise.changeEvents:read","enterprise.exports:manage","enterprise.account:read","enterprise.account:write","enterprise.user:read","enterprise.user:write","enterprise.groups:read","enterprise.groups:manage","enterprise.dataTable:read","enterprise.dataTable:write","workspacesAndBases:read","workspacesAndBases:write","workspacesAndBases:manage","workspacesAndBases.shares:manage","webhook:manage","block:manage","user.email:read"],"type":"string","x-airtable-name":"Scope","x-airtable-redirect-to-relative-path":"scopes"},"Table-Config":{"properties":{"description":{"type":"string"},"fields":{"items":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FField-Config"},"type":"array"},"name":{"type":"string"}},"required":["name","fields"],"type":"object","x-airtable-name":"Table Config","x-airtable-tag":"table"},"Table-model":{"properties":{"description":{"type":"string"},"fields":{"items":{"properties":{"description":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"options":{"x-airtable-name":"Field options","x-airtable-redirect-to-relative-path":"field-model"},"type":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FField-Type"}},"required":["id","name"],"type":"object"},"type":"array"},"id":{"type":"string"},"name":{"type":"string"},"primaryFieldId":{"description":"The first column in the table and every view.","type":"string"},"views":{"items":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"description":"View type, `block` is Gantt View","enum":["grid","form","calendar","gallery","kanban","timeline","block"],"type":"string"},"visibleFieldIds":{"description":"Available on `grid` views only: list of visible (non-hidden) field IDs, when requested with `include` query paremeter","items":{"type":"string"},"type":"array"}},"required":["id","name","type"],"type":"object"},"type":"array"}},"required":["id","name","primaryFieldId","fields","views"],"type":"object","x-airtable-name":"Table model","x-airtable-tag":"table"},"Timezone":{"anyOf":[{"enum":["utc","client"],"type":"string"},{"enum":["Africa\u002FAbidjan","Africa\u002FAccra","Africa\u002FAddis_Ababa","Africa\u002FAlgiers","Africa\u002FAsmara","Africa\u002FBamako","Africa\u002FBangui","Africa\u002FBanjul","Africa\u002FBissau","Africa\u002FBlantyre","Africa\u002FBrazzaville","Africa\u002FBujumbura","Africa\u002FCairo","Africa\u002FCasablanca","Africa\u002FCeuta","Africa\u002FConakry","Africa\u002FDakar","Africa\u002FDar_es_Salaam","Africa\u002FDjibouti","Africa\u002FDouala","Africa\u002FEl_Aaiun","Africa\u002FFreetown","Africa\u002FGaborone","Africa\u002FHarare","Africa\u002FJohannesburg","Africa\u002FJuba","Africa\u002FKampala","Africa\u002FKhartoum","Africa\u002FKigali","Africa\u002FKinshasa","Africa\u002FLagos","Africa\u002FLibreville","Africa\u002FLome","Africa\u002FLuanda","Africa\u002FLubumbashi","Africa\u002FLusaka","Africa\u002FMalabo","Africa\u002FMaputo","Africa\u002FMaseru","Africa\u002FMbabane","Africa\u002FMogadishu","Africa\u002FMonrovia","Africa\u002FNairobi","Africa\u002FNdjamena","Africa\u002FNiamey","Africa\u002FNouakchott","Africa\u002FOuagadougou","Africa\u002FPorto-Novo","Africa\u002FSao_Tome","Africa\u002FTripoli","Africa\u002FTunis","Africa\u002FWindhoek","America\u002FAdak","America\u002FAnchorage","America\u002FAnguilla","America\u002FAntigua","America\u002FAraguaina","America\u002FArgentina\u002FBuenos_Aires","America\u002FArgentina\u002FCatamarca","America\u002FArgentina\u002FCordoba","America\u002FArgentina\u002FJujuy","America\u002FArgentina\u002FLa_Rioja","America\u002FArgentina\u002FMendoza","America\u002FArgentina\u002FRio_Gallegos","America\u002FArgentina\u002FSalta","America\u002FArgentina\u002FSan_Juan","America\u002FArgentina\u002FSan_Luis","America\u002FArgentina\u002FTucuman","America\u002FArgentina\u002FUshuaia","America\u002FAruba","America\u002FAsuncion","America\u002FAtikokan","America\u002FBahia","America\u002FBahia_Banderas","America\u002FBarbados","America\u002FBelem","America\u002FBelize","America\u002FBlanc-Sablon","America\u002FBoa_Vista","America\u002FBogota","America\u002FBoise","America\u002FCambridge_Bay","America\u002FCampo_Grande","America\u002FCancun","America\u002FCaracas","America\u002FCayenne","America\u002FCayman","America\u002FChicago","America\u002FChihuahua","America\u002FCosta_Rica","America\u002FCreston","America\u002FCuiaba","America\u002FCuracao","America\u002FDanmarkshavn","America\u002FDawson","America\u002FDawson_Creek","America\u002FDenver","America\u002FDetroit","America\u002FDominica","America\u002FEdmonton","America\u002FEirunepe","America\u002FEl_Salvador","America\u002FFort_Nelson","America\u002FFortaleza","America\u002FGlace_Bay","America\u002FGodthab","America\u002FGoose_Bay","America\u002FGrand_Turk","America\u002FGrenada","America\u002FGuadeloupe","America\u002FGuatemala","America\u002FGuayaquil","America\u002FGuyana","America\u002FHalifax","America\u002FHavana","America\u002FHermosillo","America\u002FIndiana\u002FIndianapolis","America\u002FIndiana\u002FKnox","America\u002FIndiana\u002FMarengo","America\u002FIndiana\u002FPetersburg","America\u002FIndiana\u002FTell_City","America\u002FIndiana\u002FVevay","America\u002FIndiana\u002FVincennes","America\u002FIndiana\u002FWinamac","America\u002FInuvik","America\u002FIqaluit","America\u002FJamaica","America\u002FJuneau","America\u002FKentucky\u002FLouisville","America\u002FKentucky\u002FMonticello","America\u002FKralendijk","America\u002FLa_Paz","America\u002FLima","America\u002FLos_Angeles","America\u002FLower_Princes","America\u002FMaceio","America\u002FManagua","America\u002FManaus","America\u002FMarigot","America\u002FMartinique","America\u002FMatamoros","America\u002FMazatlan","America\u002FMenominee","America\u002FMerida","America\u002FMetlakatla","America\u002FMexico_City","America\u002FMiquelon","America\u002FMoncton","America\u002FMonterrey","America\u002FMontevideo","America\u002FMontserrat","America\u002FNassau","America\u002FNew_York","America\u002FNipigon","America\u002FNome","America\u002FNoronha","America\u002FNorth_Dakota\u002FBeulah","America\u002FNorth_Dakota\u002FCenter","America\u002FNorth_Dakota\u002FNew_Salem","America\u002FNuuk","America\u002FOjinaga","America\u002FPanama","America\u002FPangnirtung","America\u002FParamaribo","America\u002FPhoenix","America\u002FPort-au-Prince","America\u002FPort_of_Spain","America\u002FPorto_Velho","America\u002FPuerto_Rico","America\u002FPunta_Arenas","America\u002FRainy_River","America\u002FRankin_Inlet","America\u002FRecife","America\u002FRegina","America\u002FResolute","America\u002FRio_Branco","America\u002FSantarem","America\u002FSantiago","America\u002FSanto_Domingo","America\u002FSao_Paulo","America\u002FScoresbysund","America\u002FSitka","America\u002FSt_Barthelemy","America\u002FSt_Johns","America\u002FSt_Kitts","America\u002FSt_Lucia","America\u002FSt_Thomas","America\u002FSt_Vincent","America\u002FSwift_Current","America\u002FTegucigalpa","America\u002FThule","America\u002FThunder_Bay","America\u002FTijuana","America\u002FToronto","America\u002FTortola","America\u002FVancouver","America\u002FWhitehorse","America\u002FWinnipeg","America\u002FYakutat","America\u002FYellowknife","Antarctica\u002FCasey","Antarctica\u002FDavis","Antarctica\u002FDumontDUrville","Antarctica\u002FMacquarie","Antarctica\u002FMawson","Antarctica\u002FMcMurdo","Antarctica\u002FPalmer","Antarctica\u002FRothera","Antarctica\u002FSyowa","Antarctica\u002FTroll","Antarctica\u002FVostok","Arctic\u002FLongyearbyen","Asia\u002FAden","Asia\u002FAlmaty","Asia\u002FAmman","Asia\u002FAnadyr","Asia\u002FAqtau","Asia\u002FAqtobe","Asia\u002FAshgabat","Asia\u002FAtyrau","Asia\u002FBaghdad","Asia\u002FBahrain","Asia\u002FBaku","Asia\u002FBangkok","Asia\u002FBarnaul","Asia\u002FBeirut","Asia\u002FBishkek","Asia\u002FBrunei","Asia\u002FChita","Asia\u002FChoibalsan","Asia\u002FColombo","Asia\u002FDamascus","Asia\u002FDhaka","Asia\u002FDili","Asia\u002FDubai","Asia\u002FDushanbe","Asia\u002FFamagusta","Asia\u002FGaza","Asia\u002FHebron","Asia\u002FHo_Chi_Minh","Asia\u002FHong_Kong","Asia\u002FHovd","Asia\u002FIrkutsk","Asia\u002FIstanbul","Asia\u002FJakarta","Asia\u002FJayapura","Asia\u002FJerusalem","Asia\u002FKabul","Asia\u002FKamchatka","Asia\u002FKarachi","Asia\u002FKathmandu","Asia\u002FKhandyga","Asia\u002FKolkata","Asia\u002FKrasnoyarsk","Asia\u002FKuala_Lumpur","Asia\u002FKuching","Asia\u002FKuwait","Asia\u002FMacau","Asia\u002FMagadan","Asia\u002FMakassar","Asia\u002FManila","Asia\u002FMuscat","Asia\u002FNicosia","Asia\u002FNovokuznetsk","Asia\u002FNovosibirsk","Asia\u002FOmsk","Asia\u002FOral","Asia\u002FPhnom_Penh","Asia\u002FPontianak","Asia\u002FPyongyang","Asia\u002FQatar","Asia\u002FQostanay","Asia\u002FQyzylorda","Asia\u002FRangoon","Asia\u002FRiyadh","Asia\u002FSakhalin","Asia\u002FSamarkand","Asia\u002FSeoul","Asia\u002FShanghai","Asia\u002FSingapore","Asia\u002FSrednekolymsk","Asia\u002FTaipei","Asia\u002FTashkent","Asia\u002FTbilisi","Asia\u002FTehran","Asia\u002FThimphu","Asia\u002FTokyo","Asia\u002FTomsk","Asia\u002FUlaanbaatar","Asia\u002FUrumqi","Asia\u002FUst-Nera","Asia\u002FVientiane","Asia\u002FVladivostok","Asia\u002FYakutsk","Asia\u002FYangon","Asia\u002FYekaterinburg","Asia\u002FYerevan","Atlantic\u002FAzores","Atlantic\u002FBermuda","Atlantic\u002FCanary","Atlantic\u002FCape_Verde","Atlantic\u002FFaroe","Atlantic\u002FMadeira","Atlantic\u002FReykjavik","Atlantic\u002FSouth_Georgia","Atlantic\u002FSt_Helena","Atlantic\u002FStanley","Australia\u002FAdelaide","Australia\u002FBrisbane","Australia\u002FBroken_Hill","Australia\u002FCurrie","Australia\u002FDarwin","Australia\u002FEucla","Australia\u002FHobart","Australia\u002FLindeman","Australia\u002FLord_Howe","Australia\u002FMelbourne","Australia\u002FPerth","Australia\u002FSydney","Europe\u002FAmsterdam","Europe\u002FAndorra","Europe\u002FAstrakhan","Europe\u002FAthens","Europe\u002FBelgrade","Europe\u002FBerlin","Europe\u002FBratislava","Europe\u002FBrussels","Europe\u002FBucharest","Europe\u002FBudapest","Europe\u002FBusingen","Europe\u002FChisinau","Europe\u002FCopenhagen","Europe\u002FDublin","Europe\u002FGibraltar","Europe\u002FGuernsey","Europe\u002FHelsinki","Europe\u002FIsle_of_Man","Europe\u002FIstanbul","Europe\u002FJersey","Europe\u002FKaliningrad","Europe\u002FKiev","Europe\u002FKirov","Europe\u002FLisbon","Europe\u002FLjubljana","Europe\u002FLondon","Europe\u002FLuxembourg","Europe\u002FMadrid","Europe\u002FMalta","Europe\u002FMariehamn","Europe\u002FMinsk","Europe\u002FMonaco","Europe\u002FMoscow","Europe\u002FNicosia","Europe\u002FOslo","Europe\u002FParis","Europe\u002FPodgorica","Europe\u002FPrague","Europe\u002FRiga","Europe\u002FRome","Europe\u002FSamara","Europe\u002FSan_Marino","Europe\u002FSarajevo","Europe\u002FSaratov","Europe\u002FSimferopol","Europe\u002FSkopje","Europe\u002FSofia","Europe\u002FStockholm","Europe\u002FTallinn","Europe\u002FTirane","Europe\u002FUlyanovsk","Europe\u002FUzhgorod","Europe\u002FVaduz","Europe\u002FVatican","Europe\u002FVienna","Europe\u002FVilnius","Europe\u002FVolgograd","Europe\u002FWarsaw","Europe\u002FZagreb","Europe\u002FZaporozhye","Europe\u002FZurich","Indian\u002FAntananarivo","Indian\u002FChagos","Indian\u002FChristmas","Indian\u002FCocos","Indian\u002FComoro","Indian\u002FKerguelen","Indian\u002FMahe","Indian\u002FMaldives","Indian\u002FMauritius","Indian\u002FMayotte","Indian\u002FReunion","Pacific\u002FApia","Pacific\u002FAuckland","Pacific\u002FBougainville","Pacific\u002FChatham","Pacific\u002FChuuk","Pacific\u002FEaster","Pacific\u002FEfate","Pacific\u002FEnderbury","Pacific\u002FFakaofo","Pacific\u002FFiji","Pacific\u002FFunafuti","Pacific\u002FGalapagos","Pacific\u002FGambier","Pacific\u002FGuadalcanal","Pacific\u002FGuam","Pacific\u002FHonolulu","Pacific\u002FKanton","Pacific\u002FKiritimati","Pacific\u002FKosrae","Pacific\u002FKwajalein","Pacific\u002FMajuro","Pacific\u002FMarquesas","Pacific\u002FMidway","Pacific\u002FNauru","Pacific\u002FNiue","Pacific\u002FNorfolk","Pacific\u002FNoumea","Pacific\u002FPago_Pago","Pacific\u002FPalau","Pacific\u002FPitcairn","Pacific\u002FPohnpei","Pacific\u002FPort_Moresby","Pacific\u002FRarotonga","Pacific\u002FSaipan","Pacific\u002FTahiti","Pacific\u002FTarawa","Pacific\u002FTongatapu","Pacific\u002FWake","Pacific\u002FWallis"],"type":"string"}],"x-airtable-name":"Timezone"},"User-mentioned":{"anyOf":[{"description":"A **user** mention\n\nUsers can be mentioned by including the userId or email surrounded by `@[]`\nin the text field of the request body\n```\n{\n \"text\": \"...@[userId]....@[userEmail]...\"\n}\n```\n\nResponses from listing, creating, or updating comments\nwill indicate user mentions by including the userId surrounded by\nthe same `@[]` in the text field of the response body. The response will also\ninclude a `mentioned` objectMap that maps mentioned user and user group ids\nto detailed information\n\nIf you wish to have a list of all possible user ids, these can be found:\n - from the admin panel, by downloading the CSV available from the Users table\n - from Airtable's [Enterprise API](\u002Fapi\u002Fget-base-collaborators)\n - by using [automations](https:\u002F\u002Fsupport.airtable.com\u002Fdocs\u002Fautomations-overview) or the [scripting](https:\u002F\u002Fairtable.com\u002Fdevelopers\u002Fscripting) extension\n\n```\n{\n \"mentioned\": {\n \"userId\": {\n \"type\": \"user\",\n \"id\": \"userId\",\n \"name\": \"User Name\",\n \"email\": \"User Email\"\n }\n }\n}\n```","properties":{"displayName":{"type":"string"},"email":{"type":"string"},"id":{"description":"A user ID","type":"string"},"type":{"const":"user","type":"string"}},"required":["type","id","displayName","email"],"type":"object"},{"description":"A **user group** mention\n\nUser Groups can be mentioned by including the userGroupId surrounded by `@[]`\nin the text field of the request body\n```\n{\n \"text\": \"...@[userGroupId]...\"\n}\n```\n\nResponses from listing, creating, or updating comments\nwill indicate user group mentions by including the userGroupId surrounded by\nthe same `@[]` in the text field of the response body. It will also include\na `mentions` objectMap that maps mentioned user and group ids to detailed information.\n\nIf you wish to have a list of all possible user group ids, these can be found:\n - from the admin panel, by downloading the CSV available from the Groups table\n - from Airtable's [Enterprise API](\u002Fapi\u002Fget-base-collaborators)\n - by using [automations](https:\u002F\u002Fsupport.airtable.com\u002Fdocs\u002Fautomations-overview) or the [scripting](https:\u002F\u002Fairtable.com\u002Fdevelopers\u002Fscripting) extension\n\n```\n{\n \"mentioned\": {\n \"userGroupId\": {\n \"type\": \"userGroup\",\n \"id\": \"userGroupId\",\n \"name\": \"Group Name\"\n }\n }\n}\n```","properties":{"displayName":{"type":"string"},"id":{"description":"A user group ID","type":"string"},"type":{"const":"userGroup","type":"string"}},"required":["type","id","displayName"],"type":"object"}],"description":"The user, or user group, mentioned and returned from the comments API","x-airtable-name":"User mentioned","x-airtable-tag":"comment"},"Webhooks-action":{"anyOf":[{"properties":{"source":{"const":"client","type":"string"},"sourceMetadata":{"properties":{"user":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FWebhooks-user"}},"required":["user"],"type":"object"}},"required":["source","sourceMetadata"],"type":"object"},{"properties":{"source":{"const":"publicApi","type":"string"},"sourceMetadata":{"properties":{"user":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FWebhooks-user"}},"required":["user"],"type":"object"}},"required":["source","sourceMetadata"],"type":"object"},{"properties":{"source":{"const":"formSubmission","type":"string"},"sourceMetadata":{"properties":{"viewId":{"type":"string"}},"required":["viewId"],"type":"object"}},"required":["source","sourceMetadata"],"type":"object"},{"properties":{"source":{"const":"formPageSubmission","type":"string"},"sourceMetadata":{"properties":{"pageId":{"type":"string"}},"required":["pageId"],"type":"object"}},"required":["source","sourceMetadata"],"type":"object"},{"properties":{"source":{"const":"automation","type":"string"},"sourceMetadata":{"properties":{"automationId":{"type":"string"}},"required":["automationId"],"type":"object"}},"required":["source","sourceMetadata"],"type":"object"},{"properties":{"source":{"const":"system","type":"string"}},"required":["source"],"type":"object"},{"properties":{"source":{"const":"sync","type":"string"}},"required":["source"],"type":"object"},{"properties":{"source":{"const":"anonymousUser","type":"string"}},"required":["source"],"type":"object"}],"x-airtable-name":"Webhooks action"},"Webhooks-changed-record":{"additionalProperties":{"properties":{"current":{"properties":{"cellValuesByFieldId":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FCell-value-V2-or-null-by-fieldId"}},"required":["cellValuesByFieldId"],"type":"object"},"previous":{"properties":{"cellValuesByFieldId":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FCell-value-V2-or-null-by-fieldId"}},"required":["cellValuesByFieldId"],"type":"object"},"unchanged":{"properties":{"cellValuesByFieldId":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FCell-value-V2-or-null-by-fieldId"}},"required":["cellValuesByFieldId"],"type":"object"}},"required":["current"],"type":"object"},"description":"One or multiple records being **changed** and reported upon via webhooks.","propertyNames":{"description":"Record ID"},"type":"object","x-airtable-name":"Webhooks changed record"},"Webhooks-created-record":{"additionalProperties":{"properties":{"cellValuesByFieldId":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FCell-value-V2-by-fieldId"},"createdTime":{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"}},"required":["createdTime","cellValuesByFieldId"],"type":"object"},"description":"One or multiple records being **created** and reported upon via webhooks.","propertyNames":{"description":"Record ID"},"type":"object","x-airtable-name":"Webhooks created record"},"Webhooks-notification":{"anyOf":[{"properties":{"completionTimestamp":{"description":"The time of the most recent notification.","type":"string"},"durationMs":{"description":"The roundtrip duration of the network call.","type":"number"},"error":{"description":"Object containing the error message.","properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"retryNumber":{"description":"The number of times the notification was retried. (0 = first try)","type":"number"},"success":{"const":false,"type":"boolean"},"willBeRetried":{"description":"Whether or not Airtable will attempt to deliver a notification again.","type":"boolean"}},"required":["success","completionTimestamp","durationMs","retryNumber","error","willBeRetried"],"type":"object"},{"properties":{"completionTimestamp":{"description":"The time of the most recent notification.","type":"string"},"durationMs":{"description":"The roundtrip duration of the network call.","type":"number"},"retryNumber":{"description":"The number of times the notification was retried. (0 = first try)","type":"number"},"success":{"const":true,"type":"boolean"}},"required":["success","completionTimestamp","durationMs","retryNumber"],"type":"object"}],"description":"An object containing metadata about the most recent ping and whether or not it was successful.","x-airtable-name":"Webhooks notification"},"Webhooks-payload":{"anyOf":[{"properties":{"actionMetadata":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FWebhooks-action","description":"The action responsible for the change. We may add additional sources or source metadata in\nthe future and this will not be considered a breaking change. API consumers are expected\nto handle unknown sources gracefully."},"baseTransactionNumber":{"description":"A number which can be used to determine all changes within a transaction.","type":"number"},"changedTablesById":{"additionalProperties":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FWebhooks-table-changed"},"type":"object"},"createdTablesById":{"additionalProperties":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FWebhooks-table-created"},"type":"object"},"destroyedTableIds":{"items":{"type":"string"},"type":"array"},"payloadFormat":{"const":"v0","description":"The payload format's version number. This is currently just v0, but\nit may be increased in the future for breaking payload changes.","type":"string"},"timestamp":{"description":"The time the action occurred.","type":"string"}},"required":["actionMetadata","baseTransactionNumber","payloadFormat","timestamp"],"type":"object"},{"description":"**Error response**\n\nIf a specification becomes invalid due to a change in the base\n(e.g. deletion of a table or view specified in `recordChangeScope`, deletion\nof a field explicitly listed in `watchDataInFieldIds` or `watchSchemasOfFieldIds`),\nthe specification generates an error payload and goes into an error state.\nThe error payload may contain the change that invalidated the specification.\nIt will not reactivate automatically if the specified field\u002Fview\u002Ftable is reintroduced.\nThe caller must re-create a new webhook. If any of the fields in\n`includeCellValuesInFieldIds` are deleted, the webhook behaves as if they were not\nspecified (no error is generated and the webhook continues to generate data).\n\n```\n{\n \"payloads\": [\n {\n \"timestamp\": \"2022-02-01T21:25:05.663Z\",\n \"baseTransactionNumber\": 4,\n \"actionMetadata\": {\n \"source\": \"client\",\n \"sourceMetadata\": {\n \"user\": {\n \"id\": \"usr00000000000000\",\n \"email\": \"foo@bar.com\",\n \"permissionLevel\": \"create\"\n }\n }\n },\n \"destroyedTableIds\": [\n \"tbl20000000000000\",\n \"tbl20000000000001\"\n ],\n \"error\": true,\n \"code\": \"INVALID_HOOK\",\n \"payloadFormat\": \"v0\"\n }\n ],\n \"cursor\": 5,\n \"mightHaveMore\": false\n}\n```\nNote that for error responses `error` and `code` are the only fields that\nare typed differently from the success response.","properties":{"actionMetadata":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FWebhooks-action","description":"The action responsible for the change. We may add additional sources or source metadata in\nthe future and this will not be considered a breaking change. API consumers are expected\nto handle unknown sources gracefully."},"baseTransactionNumber":{"description":"A number which can be used to determine all changes within a transaction.","type":"number"},"changedTablesById":{"additionalProperties":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FWebhooks-table-changed"},"type":"object"},"code":{"description":"Additional error codes may be introduced, and will not\nbe considered a breaking change.\n\nIn addition `INTERNAL_ERROR` can be returned if an internal error is encountered","enum":["INVALID_FILTERS","INVALID_HOOK"],"type":"string"},"createdTablesById":{"additionalProperties":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FWebhooks-table-created"},"type":"object"},"destroyedTableIds":{"items":{"type":"string"},"type":"array"},"error":{"const":true,"type":"boolean"},"payloadFormat":{"const":"v0","description":"The payload format's version number. This is currently just v0, but\nit may be increased in the future for breaking payload changes.","type":"string"},"timestamp":{"description":"The time the action occurred.","type":"string"}},"required":["actionMetadata","baseTransactionNumber","code","error","payloadFormat","timestamp"],"type":"object"}],"description":"The contents of a webhook payload depend on the webhook's specification and the\naction performed on the base. Each action can generate one or more payload\n depending on the tables, fields and records affected.\n\nFor example, consider a webhook subscribed to all dataTypes and changeTypes.\nIf a user renames a table, that will generate a single payload. If another user\nlater adds a field, that will generate a second payload. If the new field affects\nmultiple records, such as a Formula field, then the second payload will contain\nboth the field change and the records affected.\n\nSince many records may be affected, this action may be split across multiple payloads.\nThe split payloads will have the same `timestamp`, `baseTransactionNumber`, and\n`actionMetadata`. Processing formula fields and updates from the API or sync are\nexamples of a few other sources that can result in multiple payloads.\n\n\n\n```\n{\n \"payloads\": [\n {\n \"timestamp\": \"2022-02-01T21:25:05.663Z\",\n \"baseTransactionNumber\": 4,\n \"actionMetadata\": {\n \"source\": \"client\",\n \"sourceMetadata\": {\n \"user\": {\n \"id\": \"usr00000000000000\",\n \"email\": \"foo@bar.com\",\n \"permissionLevel\": \"create\"\n }\n }\n },\n \"payloadFormat\": \"v0\"\n }\n ],\n \"cursor\": 5,\n \"mightHaveMore\": false\n}\n```\n\nClients must not assume that at least one of the following optional fields are present,\nsince we may add new fields to the payload in the future and we will not\nconsider it a breaking change. The shape of objects may change without notice, but\nexisting keys won't be changed or removed without notice.","x-airtable-name":"Webhooks payload","x-airtable-tag":"webhooks"},"Webhooks-specification":{"description":"A single webhook may watch changes in a table, view, or base. The specification defines the types of\nthe changes that are included in the webhook's payloads.\n\nNote that tables, fields, and views in the specification must be specified by ID rather than by name.\nYou may find the IDs for each of these with the manage fields UI.","properties":{"filters":{"description":"A webhook specification can contain a filters object. For example, the specification for a webhook\nwatching the data in a table is as follows:\n```\n{\n \"options\": {\n \"filters\": {\n \"dataTypes\": [\n \"tableData\"\n ],\n \"recordChangeScope\": \"tbl00000000000000\"\n }\n }\n}\n```\nThe table events can be filtered down even more to cover just record data changes for certain fields\nfrom specific sources.\n```\n{\n \"options\": {\n \"filters\": {\n \"fromSources\": [\n \"client\"\n ],\n \"dataTypes\": [\n \"tableData\"\n ],\n \"recordChangeScope\": \"tbl00000000000000\",\n \"watchDataInFieldIds\": [\n \"fld00000000000000\",\n \"fld00000000000001\",\n \"fld00000000000002\"\n ]\n }\n }\n}\n```\n\nAside from dataTypes, the keys in a filters object are optional. By default, a webhook will generate\npayloads across an entire base according to the specified dataTypes. We strongly recommend that your\nintegration specify a filters object with a subset of the filter keys to ensure that your integration\nis notified for only the most relevant events.","properties":{"changeTypes":{"description":"Only generate payloads that contain changes of these types.","items":{"enum":["add","remove","update"],"type":"string"},"type":"array"},"dataTypes":{"description":"Only generate payloads that contain changes affecting objects of these types.\n\n- `tableData`: record and cell value changes\n- `tableFields`: field changes\n- `tableMetadata`: table name and description changes","items":{"enum":["tableData","tableFields","tableMetadata"],"type":"string"},"type":"array"},"fromSources":{"description":"Only generate payloads for changes from these sources.\nIf omitted, changes from all sources are reported.\n\n - `client`: changes generated by a user through the web or mobile clients\n - `publicApi`: changes generated through the Airtable API\n - `formSubmission`: changes generated when a form _view_ is submitted\n - `formPageSubmission`: changes generated when an _interface_ form builder page, form layout page, or record creation button page is submitted\n - `automation`: changes generated through an automation action\n - `system`: changes generated by system events, such as processing time function formulas\n - `sync`: changes generated through Airtable Sync","items":{"enum":["client","publicApi","formSubmission","formPageSubmission","automation","system","sync","anonymousUser","unknown"],"type":"string"},"type":"array"},"recordChangeScope":{"description":"Only generate payloads for changes in the specified TableId or ViewId.","type":"string"},"sourceOptions":{"description":"Additional options for source filtering.\nThis allows users to filter form _view_ submissions by `ViewId`, or _interface_\nform builder page, form layout page, or record creation button page submissions by `PageId`.","properties":{"formPageSubmission":{"properties":{"pageId":{"type":"string"}},"required":["pageId"],"type":"object"},"formSubmission":{"properties":{"viewId":{"type":"string"}},"required":["viewId"],"type":"object"}},"type":"object"},"watchDataInFieldIds":{"description":"Only generate payloads for changes that modify values in cells in these fields.\nIf omitted, all fields within the table\u002Fview\u002Fbase are watched.\n\n`Warning`: If fields are specified and one of the specified fields are deleted, the webhook\nwill generate an error payload and the webhook will go into an error state and payloads will\nno longer be generated. More information about the error reponse is available in\n[Webhooks payload](\u002Fapi\u002Fmodel\u002Fwebhooks-payload).","items":{"type":"string"},"type":"array"},"watchSchemasOfFieldIds":{"description":"Only generate payloads for changes that modify the schemas of these fields.\nIf omitted, schemas of all fields within the table\u002Fview\u002Fbase are watched.\n\n`Warning`: If fields are specified and one of the specified fields are deleted, the webhook\nwill generate an error payload and the webhook will go into an error state and payloads will\nno longer be generated. More information about the error reponse is available in\n[Webhooks payload](\u002Fapi\u002Fmodel\u002Fwebhooks-payload).","items":{"type":"string"},"type":"array"}},"required":["dataTypes"],"type":"object"},"includes":{"description":"By default, the payloads only contain the data that changed. In order to generate payloads with more\ncontextual data, an includes object may be added to the specification:\n```\n{\n \"options\": {\n \"filters\": {\n \"fromSources\": [\n \"client\"\n ],\n \"dataTypes\": [\n \"tableData\"\n ],\n \"recordChangeScope\": \"tbl00000000000000\",\n \"watchDataInFieldIds\": [\n \"fld00000000000001\",\n \"fld00000000000002\"\n ]\n },\n \"includes\": {\n \"includeCellValuesInFieldIds\": [\n \"fld00000000000000\"\n ]\n }\n }\n}\n```","properties":{"includeCellValuesInFieldIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"const":"all","type":"string"}],"description":"A list of fields to include in the payload\nregardless of whether or not they changed."},"includePreviousCellValues":{"description":"If true, include the previous cell value in the payload.","type":"boolean"},"includePreviousFieldDefinitions":{"description":"If true, include the previous field definition in the payload.","type":"boolean"}},"type":"object"}},"required":["filters"],"type":"object","x-airtable-name":"Webhooks specification","x-airtable-tag":"webhooks"},"Webhooks-table-changed":{"description":"The presence of each __created*__, __destroyed*__, __changed*__ field\nis determined by the specification filters and the actual change itself.\n\nPrevious and unchanged values are only a part of the payload if the\n[specification](\u002Fapi\u002Fmodel\u002Fwebhooks-specification) contains them in the includes object.\n\n```\n{\n \"changedMetadata\": {\n \"current\": {\n \"name\": \"table name\",\n \"description\": \"table description\"\n },\n \"previous\": {\n \"name\": \"previous name\",\n \"description\": \"previous name\"\n }\n },\n \"createdFieldsById\": {\n \"fld10000000000000\": {\n \"name\": \"new name\",\n \"type\": \"number\"\n }\n },\n \"changedFieldsById\": {\n \"fld10000000000001\": {\n \"current\": {\n \"name\": \"new name\"\n },\n \"previous\": {\n \"name\": \"previous name\"\n }\n },\n \"fld10000000000002\": {\n \"current\": {\n \"type\": \"number\"\n },\n \"previous\": {\n \"type\": \"rating\"\n }\n }\n },\n \"destroyedFieldIds\": [\n \"fld10000000000003\"\n ],\n \"createdRecordsById\": {\n \"rec00000000000000\": {\n \"cellValuesByFieldId\": {\n \"fld0000000000000\": 0\n },\n \"createdTime\": \"2022-02-01T21:25:05.663Z\"\n }\n },\n \"changedRecordsById\": {\n \"rec00000000000001\": {\n \"current\": {\n \"cellValuesByFieldId\": {\n \"fld00000000000001\": \"hello world\"\n }\n },\n \"previous\": {\n \"cellValuesByFieldId\": {\n \"fld0000000000001\": \"hello\"\n }\n },\n \"unchanged\": {\n \"cellValuesByFieldId\": {\n \"fld0000000000000\": 1\n }\n }\n }\n },\n \"destroyedRecordIds\": [\n \"rec00000000000002\"\n ],\n \"changedViewsById\": {\n \"viw00000000000000\": {\n \"createdRecordsById\": {\n \"rec00000000000000\": {\n \"cellValuesByFieldId\": {\n \"fld00000000000000\": 0\n },\n \"createdTime\": \"2022-02-01T21:25:05.663Z\"\n }\n },\n \"changedRecordsById\": {\n \"rec00000000000001\": {\n \"current\": {\n \"cellValuesByFieldId\": {\n \"fld00000000000001\": \"hello world\"\n }\n },\n \"previous\": {\n \"cellValuesByFieldId\": {\n \"fld0000000000001\": \"hello\"\n }\n },\n \"unchanged\": {\n \"cellValuesByFieldId\": {\n \"fld0000000000000\": 1\n }\n }\n }\n },\n \"destroyedRecordIds\": [\n \"rec00000000000002\"\n ]\n }\n }\n```","properties":{"changedFieldsById":{"additionalProperties":{"properties":{"current":{"properties":{"name":{"type":"string"},"type":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FField-Type"}},"type":"object"},"previous":{"properties":{"name":{"type":"string"},"type":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FField-Type"}},"type":"object"}},"required":["current"],"type":"object"},"type":"object"},"changedMetadata":{"properties":{"current":{"properties":{"description":{"type":["string","null"]},"name":{"type":"string"}},"type":"object"},"previous":{"properties":{"description":{"type":["string","null"]},"name":{"type":"string"}},"type":"object"}},"required":["previous","current"],"type":"object"},"changedRecordsById":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FWebhooks-changed-record"},"changedViewsById":{"additionalProperties":{"properties":{"changedRecordsById":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FWebhooks-changed-record","description":"Changed events are generated when a record in a view changes."},"createdRecordsById":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FWebhooks-created-record","description":"Create events when a record is added or made visible to a view."},"destroyedRecordIds":{"description":"Destroyed events are generated when a record is deleted or removed from a view.","items":{"description":"Record ID","type":"string"},"type":"array"}},"type":"object"},"description":"This is only included when `recordChangeScope` is a view id.","type":"object"},"createdFieldsById":{"additionalProperties":{"properties":{"name":{"type":"string"},"type":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FField-Type"}},"required":["name","type"],"type":"object"},"type":"object"},"createdRecordsById":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FWebhooks-created-record"},"destroyedFieldIds":{"items":{"type":"string"},"type":"array"},"destroyedRecordIds":{"items":{"description":"Record ID","type":"string"},"type":"array"}},"type":"object","x-airtable-name":"Webhooks table changed"},"Webhooks-table-created":{"description":"```\n{\n \"metadata\": {\n \"name\": \"new table\",\n \"description\": \"new table description\"\n },\n \"fieldsById\": {\n \"fld00000000000000\": {\n \"name\": \"Name\",\n \"type\": \"singleLineText\"\n },\n \"fld00000000000001\": {\n \"name\": \"Description\",\n \"type\": \"multilineText\"\n }\n },\n \"recordsById\": {\n \"rec00000000000000\": {\n \"createdTime\": \"2022-02-01T21:25:05.663Z\",\n \"cellValuesByFieldId\": {\n \"fld00000000000000\": \"Hello\",\n \"fld00000000000001\": \"World\"\n }\n }\n }\n```","properties":{"fieldsById":{"additionalProperties":{"properties":{"name":{"type":"string"},"type":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FField-Type"}},"required":["name","type"],"type":"object"},"type":"object"},"metadata":{"properties":{"description":{"type":["string","null"]},"name":{"type":"string"}},"required":["name","description"],"type":"object"},"recordsById":{"additionalProperties":{"properties":{"cellValuesByFieldId":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FCell-value-V2-by-fieldId"},"createdTime":{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"}},"required":["createdTime","cellValuesByFieldId"],"type":"object"},"propertyNames":{"description":"Record ID"},"type":"object"}},"type":"object","x-airtable-name":"Webhooks table created"},"Webhooks-user":{"properties":{"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"permissionLevel":{"enum":["none","read","comment","edit","create"],"type":"string"},"profilePicUrl":{"type":"string"}},"required":["email","id","permissionLevel"],"type":"object","x-airtable-name":"Webhooks user"},"Workspace-Permission-Levels":{"anyOf":[{"const":"owner","type":"string"},{"$ref":"#\u002Fcomponents\u002Fschemas\u002FApplication-Permission-Levels"}],"x-airtable-name":"Workspace Permission Levels","x-airtable-tag":"collaborators"},"alias-1510859713-1510859713":{"properties":{"options":{"properties":{"formula":{"description":"The formula including fields referenced by their IDs. For example, LEFT(4, {Birthday})\nin the Airtable.com formula editor will be returned as LEFT(4, {fldXXX}) via API.","type":"string"},"isValid":{"description":"`false` if the formula contains an error.","type":"boolean"},"referencedFieldIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"All fields in the record that are used in the formula."},"result":{"anyOf":[{"$ref":"#\u002Fcomponents\u002Fschemas\u002FField-type-and-options"},{"type":"null"}],"description":"The resulting field type and options returned by the formula. See other field\ntype configs on this page for the possible values. Can be null if invalid."}},"required":["isValid","formula","referencedFieldIds","result"],"type":"object"},"type":{"const":"formula","type":"string"}},"required":["type","options"],"type":"object","x-airtable-redirect-to-relative-path":"field-model"}},"securitySchemes":{"oauth":{"flows":{"authorizationCode":{"authorizationUrl":"https:\u002F\u002Fairtable.com\u002Foauth2\u002Fv1\u002Fauthorize","scopes":{"block:manage":"Create new releases and submissions for custom extensions via the Blocks CLI.","data.recordComments:read":"See comments in records","data.recordComments:write":"Create, edit, and delete record comments","data.records:manage":"Permanently delete records","data.records:read":"See the data in records","data.records:write":"Create, edit, and delete records","enterprise.account:read":"View data about the enterprise account, including workspaces ids, users, groups and email domains","enterprise.account:write":"Edit data about the enterprise account, including creating descendant enterprise accounts","enterprise.auditLogs:read":"View the organization's audit logs","enterprise.changeEvents:read":"View the organization's change events","enterprise.exports:manage":"Manage the organization's data exports, including eDiscovery exports","enterprise.groups:manage":"Manage user groups under the enterprise, including moving them","enterprise.groups:read":"View information about user groups under the enterprise, their access, and their members","enterprise.scim.usersAndGroups:manage":"Manage the organization's users and groups via SCIM APIs, including provisioning and deprovisioning them.","enterprise.user:read":"View account information of users under the enterprise, including user id, name, email and bases user has access to","enterprise.user:write":"Manage users under the enterprise account, including provisioning, deactivating and deleting users","schema.bases:read":"See the structure of a base, like table names or field types","schema.bases:write":"Edit the structure of a base, like adding new fields or tables","user.email:read":"See the user's email address","webhook:manage":"View, create, delete webhooks for a base, as well as fetch webhook payloads.","workspacesAndBases.shares:manage":"View, enable, disable and delete share links for bases. Note: Share links can be used to view the data in the base.","workspacesAndBases:manage":"Manage workspaces and bases under the enterprise, including moving them","workspacesAndBases:read":"View metadata about workspaces, bases, and views including collaborators","workspacesAndBases:write":"Edit metadata of workspaces and bases, including collaborators, invites, views, and extensions"},"tokenUrl":"https:\u002F\u002Fairtable.com\u002Foauth2\u002Fv1\u002Ftoken"}},"type":"oauth2"}}},"info":{"contact":{"email":"help@airtable.com","name":"Airtable Api Team","url":"https:\u002F\u002Fairtable.com\u002Fdevelopers"},"description":"The Airtable REST API. Please see https:\u002F\u002Fairtable.com\u002Fdevelopers\u002F for more details.","termsOfService":"https:\u002F\u002Fairtable.com\u002Ftos","title":"Airtable API","version":"0"},"openapi":"3.1.0","paths":{"\u002Fscim\u002Fv2\u002FGroups":{"get":{"description":"List groups as [SCIM Groups](https:\u002F\u002Fdatatracker.ietf.org\u002Fdoc\u002Fhtml\u002Frfc7643#section-4.2) objects.\n[SCIM specification for list responses.](https:\u002F\u002Fdatatracker.ietf.org\u002Fdoc\u002Fhtml\u002Frfc7644#section-3.4.2)","operationId":"list-scim-groups","parameters":[{"in":"query","name":"count","schema":{"description":"Number of groups to return, defaults to all groups.","type":"number"}},{"in":"query","name":"filter","schema":{"description":"The SCIM spec includes additional filter options, but\nwe only support equality filtering by the Group display name, which is the SCIM displayName.","type":"string"}}],"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Success response","summary":"Success response","value":{"Resources":[{"displayName":"ExampleGroup","id":"ugpQ7PJ2boxzMAKFU","schemas":["urn:ietf:params:scim:schemas:core:2.0:Group"]}],"itemsPerPage":1,"schemas":["urn:ietf:params:scim:api:messages:2.0:ListResponse"],"startIndex":1,"totalResults":1}}},"schema":{"properties":{"Resources":{"items":{"properties":{"displayName":{"description":"Becomes the displayName of the group in Airtable. It must not be in use already.","type":["string","null"]},"id":{"description":"A user group ID","type":"string"},"schemas":{"description":"A list of schemas, including at least SCIM's core group schema URI.","items":{"type":"string"},"type":"array"}},"required":["schemas","id","displayName"],"type":"object"},"type":"array"},"itemsPerPage":{"type":"number"},"schemas":{"items":{"type":"string"},"type":"array"},"startIndex":{"description":"Position of the first result from the full list of groups, starting from 1, defaults to 1.","type":"number"},"totalResults":{"type":"number"}},"required":["schemas","totalResults","startIndex","itemsPerPage","Resources"],"type":"object"}}},"description":"Placeholder Description"}},"security":[{"oauth":["enterprise.scim.usersAndGroups:manage"]}],"summary":"List groups","tags":["scim"],"x-airtable-auth-methods":["oauthAccessToken","personalAccessToken","userApiKey"],"x-airtable-is-non-api-domain":true},"parameters":[],"post":{"description":"Create a new group from a [SCIM Group](https:\u002F\u002Fdatatracker.ietf.org\u002Fdoc\u002Fhtml\u002Frfc7643#section-4.2) object.\n\nThis endpoint creates a group with no members. Use the [patch group](\u002Fapi\u002Fpatch-scim-group) or [put group](\u002Fapi\u002Fput-scim-group) endpoints to populate the new group with members.","operationId":"create-scim-group","requestBody":{"content":{"application\u002Fjson":{"examples":{"Create user group example":{"description":"Newly created group","summary":"Create user group example","value":{"displayName":"ExampleGroup","schemas":["urn:ietf:params:scim:schemas:core:2.0:Group"]}}},"schema":{"properties":{"displayName":{"description":"Becomes the displayName of the group in Airtable. It must not be in use already.","type":["string","null"]},"schemas":{"description":"A list of schemas, including at least SCIM's core group schema URI.","items":{"type":"string"},"type":"array"}},"required":["schemas","displayName"],"type":"object"}}}},"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Create user group example":{"description":"Newly created group","summary":"Create user group example","value":{"displayName":"ExampleGroup","id":"ugpEOS67LautSwEKM","schemas":["urn:ietf:params:scim:schemas:core:2.0:Group"]}}},"schema":{"properties":{"displayName":{"description":"Becomes the displayName of the group in Airtable. It must not be in use already.","type":["string","null"]},"id":{"description":"A user group ID","type":"string"},"schemas":{"description":"A list of schemas, including at least SCIM's core group schema URI.","items":{"type":"string"},"type":"array"}},"required":["schemas","id","displayName"],"type":"object"}}},"description":"Placeholder Description"}},"security":[{"oauth":["enterprise.scim.usersAndGroups:manage"]}],"summary":"Create group","tags":["scim"],"x-airtable-auth-methods":["oauthAccessToken","personalAccessToken","userApiKey"],"x-airtable-is-non-api-domain":true}},"\u002Fscim\u002Fv2\u002FGroups\u002F{groupId}":{"delete":{"description":"Delete a single [SCIM Group](https:\u002F\u002Fdatatracker.ietf.org\u002Fdoc\u002Fhtml\u002Frfc7643#section-4.2).","operationId":"delete-scim-group","parameters":[],"responses":{"200":{"content":{"application\u002Fjson":{"schema":{"type":"object"}}},"description":"Placeholder Description"},"400":{"content":{"application\u002Fjson":{"examples":{"Unknown group ID":{"description":"With an unknown Group ID","summary":"Unknown group ID","value":{"detail":"invalid group ID","schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":400}}}}},"description":"Placeholder Description"}},"security":[{"oauth":["enterprise.scim.usersAndGroups:manage"]}],"summary":"Delete group","tags":["scim"],"x-airtable-auth-methods":["oauthAccessToken","personalAccessToken","userApiKey"],"x-airtable-is-non-api-domain":true},"get":{"description":"Get a single group as a [SCIM Group](https:\u002F\u002Fdatatracker.ietf.org\u002Fdoc\u002Fhtml\u002Frfc7643#section-4.2) object.","operationId":"get-scim-group","parameters":[],"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Success response","summary":"Success response","value":{"displayName":"ExampleGroup","id":"ugpQ7PJ2boxzMAKFU","members":[{"value":"usrI7HMkO7sAefUHk"},{"value":"usrM4UuTPOjRlDOHT"}],"schemas":["urn:ietf:params:scim:schemas:core:2.0:Group"]}}},"schema":{"description":"See [SCIM Groups](https:\u002F\u002Fdatatracker.ietf.org\u002Fdoc\u002Fhtml\u002Frfc7643#section-4.2)","properties":{"displayName":{"description":"Becomes the displayName of the group in Airtable. It must not be in use already.","type":["string","null"]},"id":{"description":"A user group ID","type":"string"},"members":{"description":"List of members of the group.","items":{"properties":{"value":{"description":"Represents the user ID of a group member","type":"string"}},"required":["value"],"type":"object"},"type":"array"},"schemas":{"description":"A list of schemas, including at least SCIM's core group schema URI.","items":{"type":"string"},"type":"array"}},"required":["schemas","id","displayName"],"type":"object"}}},"description":"Placeholder Description"},"400":{"content":{"application\u002Fjson":{"examples":{"Unknown group ID":{"description":"With an unknown Group ID","summary":"Unknown group ID","value":{"detail":"invalid group ID","schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":400}}}}},"description":"Placeholder Description"}},"security":[{"oauth":["enterprise.scim.usersAndGroups:manage"]}],"summary":"Get group","tags":["scim"],"x-airtable-auth-methods":["oauthAccessToken","personalAccessToken","userApiKey"],"x-airtable-is-non-api-domain":true},"parameters":[{"in":"path","name":"groupId","required":true,"schema":{"pattern":"[0-9a-zA-Z]{17}$","type":"string"}}],"patch":{"description":"SCIM patch an array of operations to a Group and applies them sequentially.\n\nSee [SCIM specification](https:\u002F\u002Fdatatracker.ietf.org\u002Fdoc\u002Fhtml\u002Frfc7644#section-3.5.2) for more.","operationId":"patch-scim-group","requestBody":{"content":{"application\u002Fjson":{"examples":{"Patch user group example":{"description":"Newly put group","summary":"Patch user group example","value":{"Operations":[{"op":"add","path":"members","value":{"value":"usrI7HMkO7sAefUHk"}},{"op":"remove","path":"members[value eq\"usrI7HMkO7sAefUHk\"]"},{"op":"replace","path":"members","value":[{"value":"usrI7HMkO7sAefUHk"}]},{"op":"replace","path":"displayName","value":"Updated Example Group"}],"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"]}}},"schema":{"properties":{"Operations":{"description":"A list of SCIM patch operations to perform.\n\nSee the [SCIM PATCH protocol](https:\u002F\u002Fdatatracker.ietf.org\u002Fdoc\u002Fhtml\u002Frfc7644#section-3.5.2) for details.","items":{"properties":{"op":{"enum":["add","replace","remove"],"type":"string"},"path":{"description":"Path for a [SCIM group](https:\u002F\u002Fairtable.com\u002Fapi\u002Fenterprise#scimGroupFieldTypes) field.","type":"string"},"value":{"anyOf":[{"type":"string"},{}],"description":"Replacment value. Not used when performing the `'remove'` operation."}},"required":["op","path"],"type":"object"},"type":"array"},"schemas":{"description":"A list of schemas, including at least SCIM's PatchOp schema URI.","items":{"type":"string"},"type":"array"}},"required":["schemas","Operations"],"type":"object"}}}},"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Patch user group example":{"description":"Newly put group","summary":"Patch user group example","value":{"displayName":"Updated Example Group","id":"ugpQ7PJ2boxzMAKFU","members":[{"value":"usrI7HMkO7sAefUHk"}],"schemas":["urn:ietf:params:scim:schemas:core:2.0:Group"]}}},"schema":{"description":"See [SCIM Groups](https:\u002F\u002Fdatatracker.ietf.org\u002Fdoc\u002Fhtml\u002Frfc7643#section-4.2)","properties":{"displayName":{"description":"Becomes the displayName of the group in Airtable. It must not be in use already.","type":["string","null"]},"id":{"description":"A user group ID","type":"string"},"members":{"description":"List of members of the group.","items":{"properties":{"value":{"description":"Represents the user ID of a group member","type":"string"}},"required":["value"],"type":"object"},"type":"array"},"schemas":{"description":"A list of schemas, including at least SCIM's core group schema URI.","items":{"type":"string"},"type":"array"}},"required":["schemas","id","displayName"],"type":"object"}}},"description":"Placeholder Description"}},"security":[{"oauth":["enterprise.scim.usersAndGroups:manage"]}],"summary":"Patch group","tags":["scim"],"x-airtable-auth-methods":["oauthAccessToken","personalAccessToken","userApiKey"],"x-airtable-is-non-api-domain":true},"put":{"description":"Replace a Groups's attributes with all new values.","operationId":"put-scim-group","requestBody":{"content":{"application\u002Fjson":{"examples":{"Put user group example":{"description":"Newly put group","summary":"Put user group example","value":{"displayName":"Updated Example Group","members":[{"value":"usrI7HMkO7sAefUHk"}],"schemas":["urn:ietf:params:scim:schemas:core:2.0:Group"]}}},"schema":{"properties":{"displayName":{"description":"Becomes the displayName of the group in Airtable. It must not be in use already.","type":["string","null"]},"members":{"description":"List of members of the group.","items":{"properties":{"value":{"description":"Represents the user ID of a group member","type":"string"}},"required":["value"],"type":"object"},"type":"array"},"schemas":{"description":"A list of schemas, including at least SCIM's core group schema URI.","items":{"type":"string"},"type":"array"}},"required":["schemas"],"type":"object"}}}},"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Put user group example":{"description":"Newly put group","summary":"Put user group example","value":{"displayName":"Updated Example Group","id":"ugpQ7PJ2boxzMAKFU","schemas":["urn:ietf:params:scim:schemas:core:2.0:Group"]}}},"schema":{"description":"See [SCIM Groups](https:\u002F\u002Fdatatracker.ietf.org\u002Fdoc\u002Fhtml\u002Frfc7643#section-4.2)","properties":{"displayName":{"description":"Becomes the displayName of the group in Airtable. It must not be in use already.","type":["string","null"]},"id":{"description":"A user group ID","type":"string"},"members":{"description":"List of members of the group.","items":{"properties":{"value":{"description":"Represents the user ID of a group member","type":"string"}},"required":["value"],"type":"object"},"type":"array"},"schemas":{"description":"A list of schemas, including at least SCIM's core group schema URI.","items":{"type":"string"},"type":"array"}},"required":["schemas","id","displayName"],"type":"object"}}},"description":"Placeholder Description"}},"security":[{"oauth":["enterprise.scim.usersAndGroups:manage"]}],"summary":"Put group","tags":["scim"],"x-airtable-auth-methods":["oauthAccessToken","personalAccessToken","userApiKey"],"x-airtable-is-non-api-domain":true}},"\u002Fscim\u002Fv2\u002FUsers":{"get":{"description":"List users as [SCIM User](https:\u002F\u002Fdatatracker.ietf.org\u002Fdoc\u002Fhtml\u002Frfc7643#section-4.1) objects.\n\nSee the SCIM specification for [list responses](https:\u002F\u002Fdatatracker.ietf.org\u002Fdoc\u002Fhtml\u002Frfc7644#section-3.4.2) for more.","operationId":"list-scim-users","parameters":[{"in":"query","name":"startIndex","schema":{"description":"Position of the first result from the full list of users, starting from 1,\ndefaults to 1.","type":"number"}},{"in":"query","name":"count","schema":{"description":"Number of users to return, defaults to all users.","type":"number"}},{"in":"query","name":"filter","schema":{"description":"The SCIM spec includes additional filter options, but we only support equality\nfiltering by the Airtable user email, which is the SCIM user name.","type":"string"}}],"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success":{"description":"Success response","summary":"Success","value":{"Resources":[{"active":true,"id":"usrogvSbotRtzdtZW","meta":{"created":"2021-06-02T07:37:19.000Z","location":"\u002Fscim\u002Fv2\u002FUsers\u002Fusr00000000000000","resourceType":"User"},"name":{"familyName":"Jane","givenName":"Doe"},"schemas":["urn:ietf:params:scim:schemas:core:2.0:User"],"userName":"foo@bar.com"}],"itemsPerPage":1,"schemas":["urn:ietf:params:scim:api:messages:2.0:ListResponse"],"startIndex":2,"totalResults":3}}},"schema":{"properties":{"Resources":{"items":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FSCIM-user-schema"},"type":"array"},"itemsPerPage":{"type":"number"},"schemas":{"items":{"type":"string"},"type":"array"},"startIndex":{"description":"Position of the first result from the full list of groups, starting from 1, defaults to 1.","type":"number"},"totalResults":{"type":"number"}},"required":["schemas","totalResults","startIndex","itemsPerPage","Resources"],"type":"object"}}},"description":"Placeholder Description"}},"security":[{"oauth":["enterprise.scim.usersAndGroups:manage"]}],"summary":"List users","tags":["scim"],"x-airtable-auth-methods":["oauthAccessToken","personalAccessToken","userApiKey"],"x-airtable-is-non-api-domain":true,"x-airtable-override-documentation-billing-plan":["business","enterprise","enterpriseScale"]},"parameters":[],"post":{"description":"Create a new user from a [SCIM User](https:\u002F\u002Fdatatracker.ietf.org\u002Fdoc\u002Fhtml\u002Frfc7643#section-4.1) object.\n\nThe response is the SCIM user object representing the newly created user.\nOn creation, the user will always be marked active, and the emails array will include a single entry that matches the username.\nSee the [SCIM User schema](https:\u002F\u002Fdatatracker.ietf.org\u002Fdoc\u002Fhtml\u002Frfc7643#section-4.1) for details.\n\n*WARNING*: As the user is provisioned without a password, the use of this endpoint is only intended on environments with SSO Active.\n\n*WARNING*: If your enterprise is not capturing the user's email domain, it is possible this will fail with a conflict against an\nalready created user that is not a member of your enterprise (and this not visible when [listing users](\u002Fapi\u002Flist-scim-users)). If this occurs, it is recommended you\nadd the user to your enterprise (e.g. add them to a workspace and then claim them).","operationId":"create-scim-user","requestBody":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Newly created user","summary":"Success response","value":{"name":{"familyName":"Jane","givenName":"Doe"},"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"title":"Manager","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"costCenter":"Example cost center","department":"Example department","division":"Example division","manager":{"displayName":"John Doe","value":"foo@bam.com"},"organization":"Example organization"},"userName":"foo@bar.com"}}},"schema":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FSCIM-user-schema"}}}},"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Newly created user","summary":"Success response","value":{"active":true,"id":"usrogvSbotRtzdtZW","meta":{"created":"2021-06-02T07:37:19.000Z","location":"\u002Fscim\u002Fv2\u002FUsers\u002Fusr00000000000000","resourceType":"User"},"name":{"familyName":"Jane","givenName":"Doe"},"schemas":["urn:ietf:params:scim:schemas:core:2.0:User"],"userName":"foo@bar.com"}}},"schema":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FSCIM-user-schema"}}},"description":"Placeholder Description"}},"security":[{"oauth":["enterprise.scim.usersAndGroups:manage"]}],"summary":"Create user","tags":["scim"],"x-airtable-auth-methods":["oauthAccessToken","personalAccessToken","userApiKey"],"x-airtable-is-non-api-domain":true,"x-airtable-override-documentation-billing-plan":["business","enterprise","enterpriseScale"]}},"\u002Fscim\u002Fv2\u002FUsers\u002F{userId}":{"delete":{"description":"Delete a single SCIM user.\n\n The endpoint cannot be used to delete the admin that owns the authentication token used to make the request.\n\n The endpoint cannot be used to delete the sole owner of a workspace that has multiple collaborators.\n\nSee [SCIM specification](https:\u002F\u002Fdatatracker.ietf.org\u002Fdoc\u002Fhtml\u002Frfc7644#section-3.6) for more.","operationId":"delete-scim-user","parameters":[],"responses":{"200":{"content":{"application\u002Fjson":{"schema":{"type":"object"}}},"description":"Placeholder Description"},"404":{"content":{"application\u002Fjson":{"examples":{"Unknown user ID":{"description":"With an unknown User ID","summary":"Unknown user ID","value":{"detail":"user not found","schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":404}}}}},"description":"Placeholder Description"},"422":{"content":{"application\u002Fjson":{"examples":{"Against own id":{"description":"Delete called against own ID","summary":"Against own id","value":{"detail":"Cannot perform deletion operation on own account","schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":422}},"Against sole owner of workspace with multiple collaborators":{"description":"Delete called against sole owner of workspace with multiple collaborators","summary":"Against sole owner of workspace with multiple collaborators","value":{"detail":"Cannot delete the sole owner of a workspace containing multiple collaborators","schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":422}}}}},"description":"Placeholder Description"}},"security":[{"oauth":["enterprise.scim.usersAndGroups:manage"]}],"summary":"Delete user","tags":["scim"],"x-airtable-auth-methods":["oauthAccessToken","personalAccessToken","userApiKey"],"x-airtable-is-non-api-domain":true,"x-airtable-override-documentation-billing-plan":["business","enterprise","enterpriseScale"]},"get":{"description":"Get a single user as a [SCIM User](https:\u002F\u002Fdatatracker.ietf.org\u002Fdoc\u002Fhtml\u002Frfc7643#section-4.1) object.","operationId":"get-scim-user","parameters":[],"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success":{"description":"Success response","summary":"Success","value":{"active":true,"id":"usrogvSbotRtzdtZW","meta":{"created":"2021-06-02T07:37:19.000Z","location":"\u002Fscim\u002Fv2\u002FUsers\u002Fusr00000000000000","resourceType":"User"},"name":{"familyName":"Jane","givenName":"Doe"},"schemas":["urn:ietf:params:scim:schemas:core:2.0:User"],"userName":"foo@bar.com"}}},"schema":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FSCIM-user-schema"}}},"description":"Placeholder Description"},"404":{"content":{"application\u002Fjson":{"examples":{"Unknown user Id":{"description":"With an unknown user ID","summary":"Unknown user Id","value":{"detail":"not a valid userId","schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":404}}}}},"description":"Placeholder Description"}},"security":[{"oauth":["enterprise.scim.usersAndGroups:manage"]}],"summary":"Get user","tags":["scim"],"x-airtable-auth-methods":["oauthAccessToken","personalAccessToken","userApiKey"],"x-airtable-is-non-api-domain":true,"x-airtable-override-documentation-billing-plan":["business","enterprise","enterpriseScale"]},"parameters":[{"in":"path","name":"userId","required":true,"schema":{"pattern":"[0-9a-zA-Z]{17}$","type":"string"}}],"patch":{"description":"Perform a list of SCIM patch operations in sequence on an existing user.\n\nSee [SCIM specification](https:\u002F\u002Fdatatracker.ietf.org\u002Fdoc\u002Fhtml\u002Frfc7644#section-3.5.2) for more.","operationId":"patch-scim-user","requestBody":{"content":{"application\u002Fjson":{"examples":{"Patch user example":{"description":"Newly patched user","summary":"Patch user example","value":{"Operations":[{"op":"replace","path":"title","value":"Manager"}],"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"]}}},"schema":{"properties":{"Operations":{"description":"A list of SCIM patch operations to perform.\n\nSee the [SCIM PATCH protocol](https:\u002F\u002Fdatatracker.ietf.org\u002Fdoc\u002Fhtml\u002Frfc7644#section-3.5.2) for details.","items":{"properties":{"op":{"enum":["add","replace","remove"],"type":"string"},"path":{"description":"Path for a [SCIM user](\u002Fapi\u002Fscim-overview#scim-user-objects) field.","type":"string"},"value":{"anyOf":[{"type":"string"},{}],"description":"Replacment value. Not used when performing the `'remove'` operation."}},"required":["op","path"],"type":"object"},"type":"array"},"schemas":{"description":"A list of schemas, including at least SCIM's PatchOp schema.","items":{"type":"string"},"type":"array"}},"required":["schemas","Operations"],"type":"object"}}}},"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Patch user example":{"description":"Newly patched user","summary":"Patch user example","value":{"active":true,"displayName":"Jane Doe","emails":[{"primary":true,"type":"work","value":"jane.doe@example.com"}],"externalId":"00u19pelnizu7vExD0h8","groups":[],"id":"usrogvSbotRtzdtZW","locale":"en-US","meta":{"created":"2022-06-29T18:16:07.990Z","lastModified":"2022-07-06T17:36:19.513Z","location":"\u002Fscim\u002Fv2\u002FUsers\u002Fusr00000000000000","resourceType":"User"},"name":{"familyName":"Doe","givenName":"Jane"},"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"title":"Manager","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"costCenter":"Example Cost Center","department":"Example Department","division":"Example Division"},"userName":"jane.doe@example.com"}}},"schema":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FSCIM-user-schema"}}},"description":"Placeholder Description"}},"security":[{"oauth":["enterprise.scim.usersAndGroups:manage"]}],"summary":"Patch user","tags":["scim"],"x-airtable-auth-methods":["oauthAccessToken","personalAccessToken","userApiKey"],"x-airtable-is-non-api-domain":true,"x-airtable-override-documentation-billing-plan":["business","enterprise","enterpriseScale"]},"put":{"description":"Replace a user's attributes with all new values.\n\nThe body parameters are the same as those for [creating a user](\u002Fapi\u002Fcreate-scim-user), except that you can set `active` to true or false.","operationId":"put-scim-user","requestBody":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Newly put user","summary":"Success response","value":{"active":true,"name":{"familyName":"Jane","givenName":"Doe"},"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"title":"Manager","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"costCenter":"Example cost center","department":"Example department","division":"Example division","manager":{"displayName":"John Doe","value":"foo@bam.com"},"organization":"Example organization"},"userName":"foo@bar.com"}}},"schema":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FSCIM-user-schema"}}}},"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Newly put user","summary":"Success response","value":{"active":true,"id":"usrogvSbotRtzdtZW","meta":{"created":"2021-06-02T07:37:19.000Z","location":"\u002Fscim\u002Fv2\u002FUsers\u002Fusr00000000000000","resourceType":"User"},"name":{"familyName":"Jane","givenName":"Doe"},"schemas":["urn:ietf:params:scim:schemas:core:2.0:User"],"userName":"foo@bar.com"}}},"schema":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FSCIM-user-schema"}}},"description":"Placeholder Description"}},"security":[{"oauth":["enterprise.scim.usersAndGroups:manage"]}],"summary":"Put user","tags":["scim"],"x-airtable-auth-methods":["oauthAccessToken","personalAccessToken","userApiKey"],"x-airtable-is-non-api-domain":true,"x-airtable-override-documentation-billing-plan":["business","enterprise","enterpriseScale"]}},"\u002Fv0\u002Fbases\u002F{baseId}\u002Fwebhooks":{"get":{"description":"Lists all webhooks that are registered for a base, along with their statuses.\n\n**Read level permissions are required in order to list webhooks.**","operationId":"list-webhooks","parameters":[],"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Example response":{"description":"Success response","summary":"Example response","value":{"webhooks":[{"areNotificationsEnabled":false,"cursorForNextPayload":1,"expirationTime":"2023-01-20T00:00:00.000Z","id":"ach00000000000000","isHookEnabled":true,"lastNotificationResult":null,"lastSuccessfulNotificationTime":null,"notificationUrl":null,"specification":{"options":{"filters":{"dataTypes":["tableData"],"recordChangeScope":"tbltp8DGLhqbUmjK1"}}}}]}},"Various last notifications":{"description":"Example response with various last notification responses","summary":"Various last notifications","value":{"webhooks":[{"areNotificationsEnabled":true,"cursorForNextPayload":1,"expirationTime":"2023-01-20T00:00:00.000Z","id":"ach00000000000000","isHookEnabled":true,"lastNotificationResult":{"completionTimestamp":"2022-02-01T21:25:05.663Z","durationMs":2.603,"retryNumber":0,"success":true},"lastSuccessfulNotificationTime":"2022-02-01T21:25:05.663Z","notificationUrl":"https:\u002F\u002Ffoo.com\u002Freceive-ping","specification":{"options":{"filters":{"dataTypes":["tableData"],"recordChangeScope":"tbltp8DGLhqbUmjK1"}}}},{"areNotificationsEnabled":true,"cursorForNextPayload":1,"expirationTime":"2023-01-25T00:00:00.000Z","id":"ach00000000000001","isHookEnabled":true,"lastNotificationResult":{"completionTimestamp":"2022-02-01T21:25:05.663Z","durationMs":2.603,"error":{"message":"The HTTP request returned a 503 status code instead of 200 or 204"},"retryNumber":0,"success":false,"willBeRetried":true},"lastSuccessfulNotificationTime":null,"notificationUrl":"https:\u002F\u002Ffoo.com\u002Freceive-ping","specification":{"options":{"filters":{"dataTypes":["tableData"],"recordChangeScope":"tbltp8DGLhqbUmjK1"}}}}]}}},"schema":{"properties":{"webhooks":{"items":{"properties":{"areNotificationsEnabled":{"description":"Whether or not notifications are enabled for the webhook.","type":"boolean"},"cursorForNextPayload":{"description":"The cursor associated with the next payload that will be generated.\nThis cursor will increase every time a new payload is generated for this webhook.","type":"number"},"expirationTime":{"description":"The time when the webhook expires and is disabled in the ISO format. The webhook will not expire\nif this is null (in the case User API keys are used)","type":"string"},"id":{"description":"An identifier for the webhook (WebhookId).","type":"string"},"isHookEnabled":{"description":"Whether or not the webhook is enabled. Webhooks may be turned off automatically such\nas when the specification becomes invalid. [See error codes](\u002Fapi\u002Fmodel\u002Fwebhooks-payload).","type":"boolean"},"lastNotificationResult":{"anyOf":[{"$ref":"#\u002Fcomponents\u002Fschemas\u002FWebhooks-notification"},{"type":"null"}]},"lastSuccessfulNotificationTime":{"description":"An identifier for the created webhook.","type":["string","null"]},"notificationUrl":{"description":"The url registered with the webhook. May be null if none was given.","type":["string","null"]},"specification":{"description":"The specification registered with the webhook.","properties":{"options":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FWebhooks-specification"}},"required":["options"],"type":"object"}},"required":["id","specification","notificationUrl","cursorForNextPayload","areNotificationsEnabled","lastNotificationResult","lastSuccessfulNotificationTime","isHookEnabled"],"type":"object"},"type":"array"}},"required":["webhooks"],"type":"object"}}},"description":"Placeholder Description"}},"security":[{"oauth":["webhook:manage"]}],"summary":"List webhooks","tags":["webhooks"],"x-airtable-auth-methods":["oauthAccessToken","personalAccessToken"],"x-airtable-override-documentation-scopes-and-user-role":{"scopesMarkdown":"[webhook:manage](\u002Fapi\u002Fscopes#webhook-manage)","userRoleMarkdown":"Base read-only"}},"parameters":[{"in":"path","name":"baseId","required":true,"schema":{"pattern":"app[0-9a-zA-Z]{14}$","type":"string"}}],"post":{"description":"Creates a new webhook in the specified base. Payloads may be generated and the notification URL (if given)\nwill get a ping shortly after this completes.\n\nThe number of webhooks per base is limited to 10. A single OAuth integration can create up to 2 webhooks per base.\n\nEach webhook created with OAuth or personal access token will expire and be disabled after 7 days. The webhook life can be\nextended while it is still active by calling [refresh webhook](\u002Fapi\u002Frefresh-a-webhook) or [list webhook payloads](\u002Fapi\u002Flist-webhook-payloads).\nAfter a webhook has expired and been disabled, the webhook's metadata and past payloads can be accessed for an additional 7 days.\n\n**Creator level permissions are required in order to register a webhook.**","operationId":"create-a-webhook","requestBody":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Create webhook","summary":"Success response","value":{"notificationUrl":"https:\u002F\u002Ffoo.com\u002Freceive-ping","specification":{"options":{"filters":{"dataTypes":["tableData"],"recordChangeScope":"tbltp8DGLhqbUmjK1"}}}}}},"schema":{"properties":{"notificationUrl":{"description":"An optional url that can receive notification pings. [See notification delivery](\u002Fapi\u002Fwebhooks-overview#webhook-notification-delivery).","type":["string","null"],"x-airtable-hide-null":true},"specification":{"description":"A JSON object that describe the types of changes the webhook is interested in.","properties":{"options":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FWebhooks-specification"}},"required":["options"],"type":"object"}},"required":["specification"],"type":"object"}}}},"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Create webhook","summary":"Success response","value":{"expirationTime":"2023-01-20T00:00:00.000Z","id":"ach00000000000000","macSecretBase64":"someBase64MacSecret"}}},"schema":{"properties":{"expirationTime":{"description":"The time when the webhook expires and is disabled in the ISO format. The webhook will not expire\nif this is null (in the case User API keys are used)","type":"string"},"id":{"description":"An identifier for the webhook (WebhookId).","type":"string"},"macSecretBase64":{"description":"A MAC secret. The client should store this value to authenticate webhook pings.\nThere is no way to retrieve this value after the initial creation of the webhook.","type":"string"}},"required":["id","macSecretBase64"],"type":"object"}}},"description":"Placeholder Description"}},"security":[{"oauth":["webhook:manage"]}],"summary":"Create a webhook","tags":["webhooks"],"x-airtable-auth-methods":["oauthAccessToken","personalAccessToken"],"x-airtable-override-documentation-scopes-and-user-role":{"scopesMarkdown":"Scopes depend on the subscribed [dataTypes](\u002Fapi\u002Fmodel\u002Fwebhooks-specification#filters-datatypes), more details [here](\u002Fapi\u002Fwebhooks-overview#authorization)","userRoleMarkdown":"Base creator"}}},"\u002Fv0\u002Fbases\u002F{baseId}\u002Fwebhooks\u002F{webhookId}":{"delete":{"description":"Deletes a webhook.\n\n**Creator level permissions are required in order to delete a webhook.**","operationId":"delete-a-webhook","parameters":[],"responses":{"200":{"content":{"application\u002Fjson":{"schema":{"type":"object"}}},"description":"Placeholder Description"}},"security":[{"oauth":["webhook:manage"]}],"summary":"Delete a webhook","tags":["webhooks"],"x-airtable-auth-methods":["oauthAccessToken","personalAccessToken"]},"parameters":[{"in":"path","name":"baseId","required":true,"schema":{"pattern":"app[0-9a-zA-Z]{14}$","type":"string"}},{"in":"path","name":"webhookId","required":true,"schema":{"pattern":"ach[0-9a-zA-Z]{14}$","type":"string"}}]},"\u002Fv0\u002Fbases\u002F{baseId}\u002Fwebhooks\u002F{webhookId}\u002FenableNotifications":{"parameters":[{"in":"path","name":"baseId","required":true,"schema":{"pattern":"app[0-9a-zA-Z]{14}$","type":"string"}},{"in":"path","name":"webhookId","required":true,"schema":{"pattern":"ach[0-9a-zA-Z]{14}$","type":"string"}}],"post":{"description":"Enables or disables notification pings for a webhook. See [notification delivery](\u002Fapi\u002Fwebhooks-overview#webhook-notification-delivery).\n\n**Creator level permissions are required in order to enable or disable webhook notification pings.**","operationId":"enable-disable-webhook-notifications","requestBody":{"content":{"application\u002Fjson":{"examples":{"Example request":{"description":"Example request","summary":"Example request","value":{"enable":true}}},"schema":{"properties":{"enable":{"type":"boolean"}},"required":["enable"],"type":"object"}}}},"responses":{"200":{"content":{"application\u002Fjson":{"examples":{},"schema":{"type":"object"}}},"description":"Placeholder Description"}},"security":[{"oauth":["webhook:manage"]}],"summary":"Enable\u002Fdisable webhook notifications","tags":["webhooks"],"x-airtable-auth-methods":["oauthAccessToken","personalAccessToken"]}},"\u002Fv0\u002Fbases\u002F{baseId}\u002Fwebhooks\u002F{webhookId}\u002Fpayloads":{"get":{"description":"Enumerate the update messages for a client to consume.\nClients should call this after they receive a ping.\n\nThe webhook payload format can be found [here](\u002Fapi\u002Fmodel\u002Fwebhooks-payload) and uses [V2 cell value format](\u002Fapi\u002Ffield-model).\n\nCalling this endpoint will also extend the life of the webhook if it is active with an expiration time. The new expiration time will be 7 days after the list payloads call.","operationId":"list-webhook-payloads","parameters":[{"in":"query","name":"cursor","schema":{"description":"The first time this action is called, the cursor argument may be omitted from the\nrequest and will default to 1. After that, cursors should be saved between\ninvocations of this action. When a client receives a ping, it should use the\nlast cursor that this action returned when polling for new payloads, no matter\nhow old that cursor value is. The cursor argument indicates the transaction\nnumber of the payload to start listing from.","type":"number"}},{"in":"query","name":"limit","schema":{"description":"If given the limit parameter specifies the maximum number of payloads to return\nin the response. A maximum of 50 payloads can be returned in a single request.\nA single payload can contain multiple updates.","type":"number"}}],"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success":{"description":"Success response","summary":"Success","value":{"cursor":5,"mightHaveMore":false,"payloads":[{"actionMetadata":{"source":"client","sourceMetadata":{"user":{"email":"foo@bar.com","id":"usr00000000000000","permissionLevel":"create"}}},"baseTransactionNumber":4,"payloadFormat":"v0","timestamp":"2022-02-01T21:25:05.663Z"}]}}},"schema":{"properties":{"cursor":{"description":"The cursor field in the response indicates the transaction number\nof the payload that would immediately follow the last payload returned in this request.\nPayloads are returned in transaction order, so the last payload's transaction number\nis (cursor-1), the second-to-last payload's transaction number is (cursor-2), and so\non. Each payload is associated with an incrementing cursor number. If there are no returned\npayloads, then the cursor in the response will be the same as the cursor specified in the request. The number\nof the next payload to be generated can be retrieved from cursorForNextPayload in\n[list webhooks](\u002Fapi\u002Flist-webhooks). Payloads are deleted from\nAirtable's servers after 1 week whether or not the client has seen them. The cursor value for\nthe next payload is never reset, even if payloads are deleted.","type":"number"},"mightHaveMore":{"description":"Indicates whether or not there are additional payloads.\nIf mightHaveMore is true, the client should send another request immediately and pass in the cursor from this\nresponse, as there could be more payloads. If mightHaveMore is false, there are definitely no more payloads.","type":"boolean"},"payloads":{"items":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FWebhooks-payload"},"type":"array"}},"required":["payloads","cursor","mightHaveMore"],"type":"object"}}},"description":"Placeholder Description"}},"summary":"List webhook payloads","tags":["webhooks"],"x-airtable-auth-methods":["oauthAccessToken","personalAccessToken"],"x-airtable-override-documentation-scopes-and-user-role":{"scopesMarkdown":"Scopes depend on the subscribed [dataTypes](\u002Fapi\u002Fmodel\u002Fwebhooks-specification#filters-datatypes), more details [here](\u002Fapi\u002Fwebhooks-overview#authorization)","userRoleMarkdown":"Base read-only"}},"parameters":[{"in":"path","name":"baseId","required":true,"schema":{"pattern":"app[0-9a-zA-Z]{14}$","type":"string"}},{"in":"path","name":"webhookId","required":true,"schema":{"pattern":"ach[0-9a-zA-Z]{14}$","type":"string"}}]},"\u002Fv0\u002Fbases\u002F{baseId}\u002Fwebhooks\u002F{webhookId}\u002Frefresh":{"parameters":[{"in":"path","name":"baseId","required":true,"schema":{"pattern":"app[0-9a-zA-Z]{14}$","type":"string"}},{"in":"path","name":"webhookId","required":true,"schema":{"pattern":"ach[0-9a-zA-Z]{14}$","type":"string"}}],"post":{"description":"Extend the life of a webhook. The new expiration time will be 7 days after the refresh time.\n\nNote that this endpoint only applies to active webhooks with an expiration time.\n\n**Creator level permissions are required in order to refresh a webhook.**","operationId":"refresh-a-webhook","requestBody":{"content":{"application\u002Fjson":{"schema":{"properties":{},"required":[],"type":"object"}}}},"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Refresh webhook","summary":"Success response","value":{"expirationTime":"2023-01-30T00:00:00.000Z"}}},"schema":{"properties":{"expirationTime":{"anyOf":[{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},{"type":"null"}],"description":"The new time when the webhook will expire and be disabled in the ISO format."}},"required":["expirationTime"],"type":"object"}}},"description":"Placeholder Description"}},"security":[{"oauth":["webhook:manage"]}],"summary":"Refresh a webhook","tags":["webhooks"],"x-airtable-auth-methods":["oauthAccessToken","personalAccessToken"]}},"\u002Fv0\u002Fmeta\u002Fbases":{"get":{"description":"Returns the list of bases the token can access, 1000 bases at a time.\nIf there is another page to request, pass the offset as a URL query parameter.\n(e.g. `?offset=itr23sEjsdfEr3282\u002FappSW9R5uCNmRmfl6`)","operationId":"list-bases","parameters":[{"in":"query","name":"offset","schema":{"type":["string","null"],"x-airtable-hide-null":true}}],"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Example bases","summary":"Success response","value":{"bases":[{"id":"appLkNDICXNqxSDhG","name":"Apartment Hunting","permissionLevel":"create"},{"id":"appSW9R5uCNmRmfl6","name":"Project Tracker","permissionLevel":"edit"}],"offset":"itr23sEjsdfEr3282\u002FappSW9R5uCNmRmfl6"}}},"schema":{"properties":{"bases":{"items":{"properties":{"id":{"description":"Base ID, a unique identifier for a base.","type":"string"},"name":{"type":"string"},"permissionLevel":{"enum":["none","read","comment","edit","create"],"type":"string"}},"required":["id","name","permissionLevel"],"type":"object"},"type":"array"},"offset":{"type":"string"}},"required":["bases"],"type":"object"}}},"description":"Placeholder Description"}},"security":[{"oauth":["schema.bases:read"]}],"summary":"List bases","tags":["base"],"x-airtable-auth-methods":["oauthAccessToken","personalAccessToken"]},"parameters":[],"post":{"description":"Creates a new base with the provided tables and returns the schema for the newly created base.\n\nRefer to field types for supported field types, the write format for field options, and other specifics for certain field types. Supported field types have a write format shown.\n\nAt least one table and field must be specified. The first field in the fields array will be used as the table's primary field and must be a supported primary field type. Fields must have case-insensitive unique names within the table.\n\nA default grid view will be created with all fields visible for each provided table.","operationId":"create-base","requestBody":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Success description","summary":"Success response","value":{"name":"Apartment Hunting","tables":[{"description":"A to-do list of places to visit","fields":[{"description":"Name of the apartment","name":"Name","type":"singleLineText"},{"name":"Address","type":"singleLineText"},{"name":"Visited","options":{"color":"greenBright","icon":"check"},"type":"checkbox"}],"name":"Apartments"}],"workspaceId":"wspmhESAta6clCCwF"}}},"schema":{"properties":{"name":{"description":"The name for the new base.","type":"string"},"tables":{"description":"A list of JSON objects representing\nthe tables that will be created along with the base.","items":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FTable-Config"},"type":"array"},"workspaceId":{"description":"The workspace where the base will be created.","type":"string"}},"required":["workspaceId","name","tables"],"type":"object"}}}},"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Success description","summary":"Success response","value":{"id":"appLkNDICXNqxSDhG","tables":[{"description":"A to-do list of places to visit","fields":[{"description":"Name of the apartment","id":"fld1VnoyuotSTyxW1","name":"Name","type":"singleLineText"},{"id":"fldoi0c3GaRQJ3xnI","name":"Address","type":"singleLineText"},{"id":"fldumZe00w09RYTW6","name":"Visited","options":{"color":"redBright","icon":"star"},"type":"checkbox"}],"id":"tbltp8DGLhqbUmjK1","name":"Apartments","primaryFieldId":"fld1VnoyuotSTyxW1","views":[{"id":"viwQpsuEDqHFqegkp","name":"Grid view","type":"grid"}]}]}}},"schema":{"properties":{"id":{"description":"Base ID, a unique identifier for a base.","type":"string"},"tables":{"items":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FTable-model"},"type":"array"}},"required":["id","tables"],"type":"object"}}},"description":"Placeholder Description"}},"security":[{"oauth":["schema.bases:write"]}],"summary":"Create base","tags":["base"],"x-airtable-auth-methods":["oauthAccessToken","personalAccessToken"],"x-airtable-override-documentation-scopes-and-user-role":{"userRoleMarkdown":"Workspace creator"}}},"\u002Fv0\u002Fmeta\u002Fbases\u002F{baseId}":{"delete":{"description":"Deletes the specified base. Deleted bases can be restored by workspace owners from the Trash UI, up to the workspace's billing plan retention period.","operationId":"delete-base","parameters":[],"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Success description","summary":"Success response","value":{"deleted":true,"id":"appLkNDICXNqxSDhG"}}},"schema":{"properties":{"deleted":{"const":true,"type":"boolean"},"id":{"description":"Base ID, a unique identifier for a base.","type":"string"}},"required":["deleted","id"],"type":"object"}}},"description":"Placeholder Description"},"403":{"content":{"application\u002Fjson":{"examples":{"Not admin":{"description":"Only an admin can perform this action.","summary":"Not admin","value":{"error":{"message":"You are not permitted to perform this operation","type":"INVALID_PERMISSIONS"}}}}}},"description":"Placeholder Description"}},"security":[{"oauth":["workspacesAndBases:manage"]}],"summary":"Delete base","tags":["workspace"],"x-airtable-auth-methods":["personalAccessToken","oauthAccessToken"]},"get":{"description":"Returns basic information on the base. Does not include deleted collaborators and only include [outstanding](\u002Fapi\u002Forg-management-glossary#outstanding-invite) invites.","operationId":"get-base-collaborators","parameters":[{"examples":{"Success response":{"description":"Success Response","summary":"Success response","value":["collaborators"]}},"in":"query","name":"include","schema":{"description":"If specified, collaborators, interfaces and\u002For inviteLinks key will be included in the response object. Otherwise, they will be left out.","items":{"enum":["collaborators","inviteLinks","interfaces"],"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Success Response","summary":"Success response","value":{"collaborators":{"baseCollaborators":[{"createdTime":"2019-01-03T12:33:12.421Z","email":"foo@bam.com","grantedByUserId":"usrL2PNC5o3H4lBEi","permissionLevel":"create","userId":"usrsOEchC9xuwRgKk"}],"workspaceCollaborators":[{"createdTime":"2019-01-03T12:33:12.421Z","email":"foo@bar.com","grantedByUserId":"usrL2PNC5o3H4lBEi","permissionLevel":"owner","userId":"usrL2PNC5o3H4lBEi"}]},"createdTime":"2019-01-03T12:33:12.421Z","groupCollaborators":{"baseCollaborators":[{"createdTime":"2019-01-03T12:33:12.421Z","grantedByUserId":"usrL2PNC5o3H4lBEi","groupId":"ugpR8ZT9KtIgp8Bh3","name":"group 2","permissionLevel":"create"}],"workspaceCollaborators":[{"createdTime":"2019-01-03T12:33:12.421Z","grantedByUserId":"usrL2PNC5o3H4lBEi","groupId":"ugp1mKGb3KXUyQfOZ","name":"group 1","permissionLevel":"edit"}]},"id":"appLkNDICXNqxSDhG","individualCollaborators":{"baseCollaborators":[{"createdTime":"2019-01-03T12:33:12.421Z","email":"foo@bam.com","grantedByUserId":"usrL2PNC5o3H4lBEi","permissionLevel":"create","userId":"usrsOEchC9xuwRgKk"}],"workspaceCollaborators":[{"createdTime":"2019-01-03T12:33:12.421Z","email":"foo@bar.com","grantedByUserId":"usrL2PNC5o3H4lBEi","permissionLevel":"owner","userId":"usrL2PNC5o3H4lBEi"}]},"interfaces":{"pbdyGA3PsOziEHPDE":{"createdTime":"2019-01-03T12:33:12.421Z","firstPublishTime":"2019-01-03T12:36:12.421Z","groupCollaborators":[{"createdTime":"2019-01-03T12:33:12.421Z","grantedByUserId":"usrL2PNC5o3H4lBEi","groupId":"ugpR8ZT9KtIgp8Bh3","name":"group 2","permissionLevel":"create"}],"id":"pbdyGA3PsOziEHPDE","individualCollaborators":[{"createdTime":"2019-01-04T12:33:12.421Z","email":"bam@bam.com","grantedByUserId":"usrL2PNC5o3H4lBEi","permissionLevel":"edit","userId":"usrGcrteE5fUMqq0R"}],"inviteLinks":[{"createdTime":"2019-01-03T12:33:12.421Z","id":"invJiqaXmPqq6Ec87","invitedEmail":null,"permissionLevel":"read","referredByUserId":"usrL2PNC5o3H4lBEi","restrictedToEmailDomains":[],"type":"multiUse"}],"name":"My first interface"}},"inviteLinks":{"baseInviteLinks":[{"createdTime":"2019-01-03T12:33:12.421Z","id":"invJiqaXmPqq6Ec87","invitedEmail":null,"permissionLevel":"read","referredByUserId":"usrsOEchC9xuwRgKk","restrictedToEmailDomains":["bam.com"],"type":"multiUse"}],"workspaceInviteLinks":[{"createdTime":"2019-01-03T12:33:12.421Z","id":"invJiqaXmPqq6Ec87","invitedEmail":"bam@bam.com","permissionLevel":"edit","referredByUserId":"usrL2PNC5o3H4lBEi","restrictedToEmailDomains":[],"type":"singleUse"}]},"name":"my first base","permissionLevel":"none","workspaceId":"wspmhESAta6clCCwF"}}},"schema":{"properties":{"collaborators":{"deprecated":true,"description":"Please use **individualCollaborators** and **groupCollaborators** instead.","properties":{"baseCollaborators":{"items":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FIndividual-Collaborator"},"type":"array"},"workspaceCollaborators":{"items":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FIndividual-Collaborator"},"type":"array"}},"required":["workspaceCollaborators","baseCollaborators"],"type":"object"},"createdTime":{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},"groupCollaborators":{"description":"Groups whose members are collaborating on this base.","properties":{"baseCollaborators":{"items":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FGroup-Collaborator"},"type":"array"},"workspaceCollaborators":{"items":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FGroup-Collaborator"},"type":"array"}},"required":["workspaceCollaborators","baseCollaborators"],"type":"object"},"id":{"description":"Base ID, a unique identifier for a base.","type":"string"},"individualCollaborators":{"description":"Individual users that are explicitly added as collaborators on the base.\nDoes not include users that only have access via membership in a group that has been added as a collaborator.","properties":{"baseCollaborators":{"items":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FIndividual-Collaborator"},"type":"array"},"workspaceCollaborators":{"items":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FIndividual-Collaborator"},"type":"array"}},"required":["workspaceCollaborators","baseCollaborators"],"type":"object"},"interfaces":{"additionalProperties":{"properties":{"createdTime":{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},"firstPublishTime":{"anyOf":[{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},{"type":"null"}]},"groupCollaborators":{"items":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FGroup-Collaborator"},"type":"array"},"id":{"description":"Interface ID (also known as `pageBundleId`)","type":"string"},"individualCollaborators":{"items":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FIndividual-Collaborator"},"type":"array"},"inviteLinks":{"items":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FInvite-link"},"type":"array"},"name":{"type":"string"}},"required":["id","name","createdTime","firstPublishTime"],"type":"object"},"type":"object"},"inviteLinks":{"properties":{"baseInviteLinks":{"items":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FInvite-link"},"type":"array"},"workspaceInviteLinks":{"items":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FInvite-link"},"type":"array"}},"required":["baseInviteLinks"],"type":"object"},"name":{"type":"string"},"permissionLevel":{"description":"Collaborator permission level of the endpoint authenticator in the base.\n\"none\" for enterprise admin who is not a collaborator in the base but has permission to this endpoint.","enum":["none","read","comment","edit","create","owner"],"type":"string"},"workspaceId":{"description":"ID of the workspace that contains this base.","type":"string"}},"required":["id","name","permissionLevel","createdTime","workspaceId"],"type":"object"}}},"description":"Placeholder Description"}},"security":[{"oauth":["workspacesAndBases:read"]}],"summary":"Get base collaborators","tags":["collaborators"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"]},"parameters":[{"in":"path","name":"baseId","required":true,"schema":{"pattern":"app[0-9a-zA-Z]{14}$","type":"string"}}]},"\u002Fv0\u002Fmeta\u002Fbases\u002F{baseId}\u002FblockInstallations":{"get":{"description":"Lists basic information of base block installations.","operationId":"list-block-installations","parameters":[],"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Success Response","summary":"Success response","value":[{"blockId":"blkSmwFJEdER6oksM","blockSlug":"chart","createdByUserId":"usrL2PNC5o3H4lBEi","createdTime":"2019-01-01T00:00:00.000Z","id":"bliXyN0Q6zfajnDOG","state":"enabled"}]}},"schema":{"items":{"properties":{"blockId":{"type":"string"},"blockSlug":{"description":"Unique readable string identifier for a block. Only present for Airtable authored blocks.","type":"string"},"createdByUserId":{"description":"A user ID","type":"string"},"createdTime":{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},"id":{"type":"string"},"state":{"enum":["enabled","disabled"],"type":"string"}},"required":["id","state","blockId","createdByUserId","createdTime"],"type":"object"},"type":"array"}}},"description":"Placeholder Description"}},"security":[{"oauth":["workspacesAndBases:read"]}],"summary":"List block installations","tags":["block"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"]},"parameters":[{"in":"path","name":"baseId","required":true,"schema":{"pattern":"app[0-9a-zA-Z]{14}$","type":"string"}}]},"\u002Fv0\u002Fmeta\u002Fbases\u002F{baseId}\u002FblockInstallations\u002F{blockInstallationId}":{"delete":{"description":"A deleted block installation is recoverable.","operationId":"delete-block-installation","parameters":[],"responses":{"200":{"content":{"application\u002Fjson":{"schema":{"type":"null"}}},"description":"Placeholder Description"}},"security":[{"oauth":["workspacesAndBases:write"]}],"summary":"Delete block installation","tags":["block"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"]},"parameters":[{"in":"path","name":"baseId","required":true,"schema":{"pattern":"app[0-9a-zA-Z]{14}$","type":"string"}},{"in":"path","name":"blockInstallationId","required":true,"schema":{"pattern":"bli[0-9a-zA-Z]{14}$","type":"string"}}],"patch":{"description":"Manages block installation state.","operationId":"manage-block-installation","requestBody":{"content":{"application\u002Fjson":{"examples":{"Example Request":{"description":"Example Request","summary":"Example Request","value":{"state":"disabled"}}},"schema":{"properties":{"state":{"enum":["enabled","disabled"],"type":"string"}},"required":["state"],"type":"object"}}}},"responses":{"200":{"content":{"application\u002Fjson":{"examples":{}}},"description":"Placeholder Description"}},"security":[{"oauth":["workspacesAndBases:write"]}],"summary":"Manage block installation","tags":["block"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"]}},"\u002Fv0\u002Fmeta\u002Fbases\u002F{baseId}\u002Fcollaborators":{"parameters":[{"in":"path","name":"baseId","required":true,"schema":{"pattern":"app[0-9a-zA-Z]{14}$","type":"string"}}],"post":{"description":"Add a new base collaborator. Despite the name, this route currently only supports adding one collaborator at a time.","operationId":"add-base-collaborator","requestBody":{"content":{"application\u002Fjson":{"examples":{"Success example":{"description":"Example","summary":"Success example","value":{"collaborators":[{"permissionLevel":"edit","user":{"id":"usr00000000000000"}}]}}},"schema":{"properties":{"collaborators":{"description":"This endpoint accepts two types of collaborators: **individual user** and **group**.","items":{"anyOf":[{"properties":{"permissionLevel":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FApplication-Permission-Levels"},"user":{"properties":{"id":{"description":"A user ID","type":"string"}},"required":["id"],"type":"object"}},"required":["permissionLevel","user"],"type":"object"},{"properties":{"group":{"properties":{"id":{"description":"A user group ID","type":"string"}},"required":["id"],"type":"object"},"permissionLevel":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FApplication-Permission-Levels"}},"required":["group","permissionLevel"],"type":"object"}]},"type":"array"}},"required":["collaborators"],"type":"object"}}}},"responses":{"200":{"content":{"application\u002Fjson":{"examples":{}}},"description":"Placeholder Description"},"403":{"content":{"application\u002Fjson":{"examples":{"Add more than one collaborator":{"description":"This route currently supports adding only one collaborator at a time.","summary":"Add more than one collaborator","value":{"error":{"message":"You are only permitted to add one collaborator at a time","type":"INVALID_PERMISSIONS"}}},"Email not verified":{"description":"The userId must correspond to a verified account.","summary":"Email not verified","value":{"error":{"message":"User must be active and email verified","type":"INVALID_PERMISSIONS"}}}}}},"description":"Placeholder Description"}},"security":[{"oauth":["workspacesAndBases:write"]}],"summary":"Add base collaborator","tags":["collaborators"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"],"x-airtable-override-documentation-scopes-and-user-role":{"userRoleMarkdown":"Base collaborators subject to [sharing restrictions](https:\u002F\u002Fsupport.airtable.com\u002Fdocs\u002Fworkspace-sharing-restrictions)"}}},"\u002Fv0\u002Fmeta\u002Fbases\u002F{baseId}\u002Fcollaborators\u002F{userOrGroupId}":{"delete":{"description":"Delete a base collaborator.","operationId":"delete-base-collaborator","parameters":[],"responses":{"200":{"content":{"application\u002Fjson":{}},"description":"Placeholder Description"}},"security":[{"oauth":["workspacesAndBases:write"]}],"summary":"Delete base collaborator","tags":["collaborators"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"],"x-airtable-override-documentation-scopes-and-user-role":{"userRoleMarkdown":"Base collaborators subject to [sharing restrictions](https:\u002F\u002Fsupport.airtable.com\u002Fdocs\u002Fworkspace-sharing-restrictions)"}},"parameters":[{"in":"path","name":"baseId","required":true,"schema":{"pattern":"app[0-9a-zA-Z]{14}$","type":"string"}},{"in":"path","name":"userOrGroupId","required":true,"schema":{"pattern":"usr[0-9a-zA-Z]{14}|ugp[0-9a-zA-Z]{14}$","type":"string"}}],"patch":{"description":"Updates the permission level of a collaborator on a base.","operationId":"update-collaborator-base-permission","requestBody":{"content":{"application\u002Fjson":{"examples":{"Example Request":{"description":"Example Request","summary":"Example Request","value":{"permissionLevel":"read"}}},"schema":{"properties":{"permissionLevel":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FApplication-Permission-Levels"}},"required":["permissionLevel"],"type":"object"}}}},"responses":{"200":{"content":{"application\u002Fjson":{"examples":{}}},"description":"Placeholder Description"},"403":{"content":{"application\u002Fjson":{"examples":{"Not base collaborator":{"description":"This route can only be used for users who are already collaborators on the base. To add a new collaborator, use the [add base collaborator](base-addBaseCollaborators) route.","summary":"Not base collaborator","value":{"error":{"message":"Invalid permissions","type":"INVALID_PERMISSIONS"}}}}}},"description":"Placeholder Description"}},"security":[{"oauth":["workspacesAndBases:write"]}],"summary":"Update collaborator base permission","tags":["collaborators"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"],"x-airtable-override-documentation-scopes-and-user-role":{"userRoleMarkdown":"Base collaborators subject to [sharing restrictions](https:\u002F\u002Fsupport.airtable.com\u002Fdocs\u002Fworkspace-sharing-restrictions)"}}},"\u002Fv0\u002Fmeta\u002Fbases\u002F{baseId}\u002Finterfaces\u002F{pageBundleId}":{"get":{"description":"Returns general information about the interface. Does not include deleted collaborators and only includes [outstanding](\u002Fapi\u002Forg-management-glossary#outstanding-invite) invites.\n\n`pageBundleId` is the ID of the interface and can be found in the [`interfaces`](\u002Fapi\u002Fget-base-collaborators#response-interfaces) object returned by the [get base collaborators](\u002Fapi\u002Fget-base-collaborators) endpoint.","operationId":"get-interface","parameters":[{"in":"query","name":"include","schema":{"items":{"enum":["collaborators","inviteLinks"],"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application\u002Fjson":{"schema":{"properties":{"baseId":{"description":"Base ID, a unique identifier for a base.","type":"string"},"createdTime":{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},"groupCollaborators":{"properties":{"baseCollaborators":{"items":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FGroup-Collaborator"},"type":"array"},"interfaceCollaborators":{"items":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FGroup-Collaborator"},"type":"array"},"workspaceCollaborators":{"items":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FGroup-Collaborator"},"type":"array"}},"required":["workspaceCollaborators","baseCollaborators","interfaceCollaborators"],"type":"object"},"id":{"type":"string"},"individualCollaborators":{"properties":{"baseCollaborators":{"items":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FIndividual-Collaborator"},"type":"array"},"interfaceCollaborators":{"items":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FIndividual-Collaborator"},"type":"array"},"workspaceCollaborators":{"items":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FIndividual-Collaborator"},"type":"array"}},"required":["workspaceCollaborators","baseCollaborators","interfaceCollaborators"],"type":"object"},"inviteLinks":{"items":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FInvite-link"},"type":"array"},"name":{"type":"string"},"permissionLevel":{"enum":["none","read","comment","edit","create","owner"],"type":"string"}},"required":["id","name","baseId","permissionLevel","createdTime"],"type":"object"}}},"description":"Placeholder Description"}},"security":[{"oauth":["workspacesAndBases:read"]}],"summary":"Get interface","tags":["collaborators"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"]},"parameters":[{"in":"path","name":"baseId","required":true,"schema":{"pattern":"app[0-9a-zA-Z]{14}$","type":"string"}},{"in":"path","name":"pageBundleId","required":true,"schema":{"pattern":"pbd[0-9a-zA-Z]{14}$","type":"string"}}]},"\u002Fv0\u002Fmeta\u002Fbases\u002F{baseId}\u002Finterfaces\u002F{pageBundleId}\u002Fcollaborators":{"parameters":[{"in":"path","name":"baseId","required":true,"schema":{"pattern":"app[0-9a-zA-Z]{14}$","type":"string"}},{"in":"path","name":"pageBundleId","required":true,"schema":{"pattern":"pbd[0-9a-zA-Z]{14}$","type":"string"}}],"post":{"description":"Use this to add a collaborator to an interface.","operationId":"add-interface-collaborator","requestBody":{"content":{"application\u002Fjson":{"schema":{"properties":{"collaborators":{"description":"This endpoint accepts two types of collaborators: **individual user** and **group**. This route currently supports adding only one collaborator at a time.","items":{"anyOf":[{"properties":{"group":{"not":{}},"permissionLevel":{"enum":["read","comment","edit"],"type":"string"},"user":{"properties":{"id":{"description":"A user ID","type":"string"}},"required":["id"],"type":"object"}},"required":["permissionLevel","user"],"type":"object"},{"properties":{"group":{"properties":{"id":{"description":"A user group ID","type":"string"}},"required":["id"],"type":"object"},"permissionLevel":{"enum":["read","comment","edit"],"type":"string"},"user":{"not":{}}},"required":["group","permissionLevel"],"type":"object"}]},"type":"array"}},"required":["collaborators"],"type":"object"}}}},"responses":{"200":{"content":{"application\u002Fjson":{}},"description":"Placeholder Description"}},"security":[{"oauth":["workspacesAndBases:write"]}],"summary":"Add interface collaborator","tags":["collaborators"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"],"x-airtable-override-documentation-scopes-and-user-role":{"userRoleMarkdown":"Base collaborators subject to [sharing restrictions](https:\u002F\u002Fsupport.airtable.com\u002Fdocs\u002Fworkspace-sharing-restrictions)"}}},"\u002Fv0\u002Fmeta\u002Fbases\u002F{baseId}\u002Finterfaces\u002F{pageBundleId}\u002Fcollaborators\u002F{userOrGroupId}":{"delete":{"description":"Delete an interface collaborator. Requires base collaborator access to remove others, but can be used to remove yourself even with interface-only collaborator access.","operationId":"delete-interface-collaborator","parameters":[],"responses":{"200":{"content":{"application\u002Fjson":{}},"description":"Placeholder Description"}},"security":[{"oauth":["workspacesAndBases:write"]}],"summary":"Delete interface collaborator","tags":["collaborators"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"],"x-airtable-override-documentation-scopes-and-user-role":{"userRoleMarkdown":"Base collaborators subject to [sharing restrictions](https:\u002F\u002Fsupport.airtable.com\u002Fdocs\u002Fworkspace-sharing-restrictions)"}},"parameters":[{"in":"path","name":"baseId","required":true,"schema":{"pattern":"app[0-9a-zA-Z]{14}$","type":"string"}},{"in":"path","name":"pageBundleId","required":true,"schema":{"pattern":"pbd[0-9a-zA-Z]{14}$","type":"string"}},{"in":"path","name":"userOrGroupId","required":true,"schema":{"pattern":"usr[0-9a-zA-Z]{14}|ugp[0-9a-zA-Z]{14}$","type":"string"}}],"patch":{"description":"Use this to update permissions for an interface-only collaborator.","operationId":"update-interface-collaborator","requestBody":{"content":{"application\u002Fjson":{"schema":{"properties":{"permissionLevel":{"enum":["read","comment","edit"],"type":"string"}},"required":["permissionLevel"],"type":"object"}}}},"responses":{"200":{"content":{"application\u002Fjson":{}},"description":"Placeholder Description"}},"security":[{"oauth":["workspacesAndBases:write"]}],"summary":"Update interface collaborator","tags":["collaborators"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"],"x-airtable-override-documentation-scopes-and-user-role":{"userRoleMarkdown":"Base collaborators subject to [sharing restrictions](https:\u002F\u002Fsupport.airtable.com\u002Fdocs\u002Fworkspace-sharing-restrictions)"}}},"\u002Fv0\u002Fmeta\u002Fbases\u002F{baseId}\u002Finterfaces\u002F{pageBundleId}\u002Finvites\u002F{inviteId}":{"delete":{"description":"Delete an interface invite.\n\nThe invite must be [outstanding](\u002Fapi\u002Forg-management-glossary#outstanding-invite).","operationId":"delete-interface-invite","parameters":[],"responses":{"200":{"content":{"application\u002Fjson":{}},"description":"Placeholder Description"},"403":{"content":{"application\u002Fjson":{"examples":{"Invite not outstanding":{"description":"The invite must be [outstanding](\u002Fapi\u002Forg-management-glossary#outstanding-invite).","summary":"Invite not outstanding","value":{"error":{"message":"You are not permitted to perform this operation","type":"INVALID_PERMISSIONS"}}}}}},"description":"Placeholder Description"}},"security":[{"oauth":["workspacesAndBases:write"]}],"summary":"Delete interface invite","tags":["invites"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"]},"parameters":[{"in":"path","name":"baseId","required":true,"schema":{"pattern":"app[0-9a-zA-Z]{14}$","type":"string"}},{"in":"path","name":"pageBundleId","required":true,"schema":{"pattern":"pbd[0-9a-zA-Z]{14}$","type":"string"}},{"in":"path","name":"inviteId","required":true,"schema":{"pattern":"inv[0-9a-zA-Z]{14}$","type":"string"}}]},"\u002Fv0\u002Fmeta\u002Fbases\u002F{baseId}\u002Finvites\u002F{inviteId}":{"delete":{"description":"Delete a base invite.\n\nThe invite must be [outstanding](\u002Fapi\u002Forg-management-glossary#outstanding-invite).","operationId":"delete-base-invite","parameters":[],"responses":{"200":{"content":{"application\u002Fjson":{}},"description":"Placeholder Description"},"403":{"content":{"application\u002Fjson":{"examples":{"Invite not outstanding":{"description":"The invite must be [outstanding](\u002Fapi\u002Forg-management-glossary#outstanding-invite).","summary":"Invite not outstanding","value":{"error":{"message":"You are not permitted to perform this operation","type":"INVALID_PERMISSIONS"}}}}}},"description":"Placeholder Description"}},"security":[{"oauth":["workspacesAndBases:write"]}],"summary":"Delete base invite","tags":["invites"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"],"x-airtable-override-documentation-scopes-and-user-role":{"userRoleMarkdown":"Base collaborators subject to [sharing restrictions](https:\u002F\u002Fsupport.airtable.com\u002Fdocs\u002Fworkspace-sharing-restrictions)"}},"parameters":[{"in":"path","name":"baseId","required":true,"schema":{"pattern":"app[0-9a-zA-Z]{14}$","type":"string"}},{"in":"path","name":"inviteId","required":true,"schema":{"pattern":"inv[0-9a-zA-Z]{14}$","type":"string"}}]},"\u002Fv0\u002Fmeta\u002Fbases\u002F{baseId}\u002Fshares":{"get":{"description":"Lists basic information of base shares.","operationId":"list-shares","parameters":[],"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Success Response","summary":"Success response","value":{"shares":[{"createdByUserId":"usrL2PNC5o3H4lBEi","createdTime":"2019-01-01T00:00:00.000Z","effectiveEmailDomainAllowList":["foobar.com"],"isPasswordProtected":true,"restrictedToEmailDomains":["foobar.com"],"shareId":"shr9SpczJvQpfAzSp","shareTokenPrefix":"shr9Spcz","state":"enabled","type":"base"},{"canBeSynced":true,"createdByUserId":"usrL2PNC5o3H4lBEi","createdTime":"2019-01-01T00:00:00.000Z","isPasswordProtected":false,"restrictedToEmailDomains":[],"shareId":"shrMg5vs9SpczJvQp","shareTokenPrefix":"shrMg5vs","state":"disabled","type":"view","viewId":"viwQpsuEDqHFqegkp"},{"blockInstallationId":"bliXyN0Q6zfajnDOG","createdByUserId":"usrL2PNC5o3H4lBEi","createdTime":"2019-01-01T00:00:00.000Z","isPasswordProtected":false,"restrictedToEmailDomains":[],"shareId":"shrjjKdhMg5vs9Spc","shareTokenPrefix":"shrjjKdh","state":"disabled","type":"blockInstallation"}]}}},"schema":{"properties":{"shares":{"items":{"properties":{"blockInstallationId":{"type":"string"},"canBeSynced":{"description":"Denotes if the shared view can be synced. View and enterprise specific sync restrictions may also apply.","type":"boolean"},"createdByUserId":{"description":"A user ID","type":"string"},"createdTime":{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},"effectiveEmailDomainAllowList":{"description":"The effective email domain allow list factoring all restrictions,\nincluding the share's email domain restrictions and all restrictions above the share\n(e.g. enterprise sharing restrictions). If this field is omitted,\nthere are no email domain restrictions on the share. Otherwise, a viewer must have\nan account associated with an email domain included in the allow list. If this list is empty,\nno viewer can see the share\n(e.g. no member of restrictedToEmailDomains is allowed by enterprise-wise sharing restrictions).","items":{"type":"string"},"type":"array"},"isPasswordProtected":{"type":"boolean"},"restrictedToEmailDomains":{"description":"If non-empty, the email domain restrictions assigned to the share.\nIf empty, no domain restrictions are assigned to the share, but higher level ones may still affect it.\nWe recommend using effectiveEmailDomainAllowList to understand share accessibility.","items":{"type":"string"},"type":"array"},"shareId":{"description":"The full ShareId (unique identifier for the share).","type":"string"},"shareTokenPrefix":{"deprecated":true,"description":"Only the first 8 characters of the shareId.\n\nPlease use `shareId` instead.","type":"string"},"state":{"enum":["enabled","disabled"],"type":"string"},"type":{"enum":["base","view","blockInstallation"],"type":"string"},"viewId":{"type":"string"}},"required":["shareTokenPrefix","shareId","state","type","createdByUserId","isPasswordProtected","restrictedToEmailDomains","createdTime"],"type":"object"},"type":"array"}},"required":["shares"],"type":"object"}}},"description":"Placeholder Description"}},"security":[{"oauth":["workspacesAndBases.shares:manage"]}],"summary":"List shares","tags":["shares"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"]},"parameters":[{"in":"path","name":"baseId","required":true,"schema":{"pattern":"app[0-9a-zA-Z]{14}$","type":"string"}}]},"\u002Fv0\u002Fmeta\u002Fbases\u002F{baseId}\u002Fshares\u002F{shareId}":{"delete":{"description":"**WARNING:** Hard deleted share is NOT recoverable!!!","operationId":"delete-share","parameters":[],"responses":{"200":{"content":{"application\u002Fjson":{}},"description":"Placeholder Description"}},"security":[{"oauth":["workspacesAndBases.shares:manage"]}],"summary":"Delete share","tags":["shares"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"]},"parameters":[{"in":"path","name":"baseId","required":true,"schema":{"pattern":"app[0-9a-zA-Z]{14}$","type":"string"}},{"in":"path","name":"shareId","required":true,"schema":{"pattern":"shr[0-9a-zA-Z]{5,14}$","type":"string"}}],"patch":{"description":"Manages share state.","operationId":"manage-share","requestBody":{"content":{"application\u002Fjson":{"examples":{"Example Request":{"description":"Example Request","summary":"Example Request","value":{"state":"disabled"}}},"schema":{"properties":{"state":{"description":"When _enabling_ a share a user is subject to\n[sharing restrictions](https:\u002F\u002Fsupport.airtable.com\u002Fdocs\u002Fworkspace-sharing-restrictions).\nThese restrictions are not applicable when disabling a share.","enum":["enabled","disabled"],"type":"string"}},"required":["state"],"type":"object"}}}},"responses":{"200":{"content":{"application\u002Fjson":{"examples":{}}},"description":"Placeholder Description"}},"security":[{"oauth":["workspacesAndBases.shares:manage"]}],"summary":"Manage share","tags":["shares"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"],"x-airtable-override-documentation-scopes-and-user-role":{"userRoleMarkdown":"Base editor with caveats, see `state` below"}}},"\u002Fv0\u002Fmeta\u002Fbases\u002F{baseId}\u002Ftables":{"get":{"description":"Returns the schema of the tables in the specified base.","operationId":"get-base-schema","parameters":[{"in":"query","name":"include","schema":{"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)","items":{"const":"visibleFieldIds","type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Example tables","summary":"Success response","value":{"tables":[{"description":"Apartments to track.","fields":[{"description":"Name of the apartment","id":"fld1VnoyuotSTyxW1","name":"Name","type":"singleLineText"},{"id":"fldoaIqdn5szURHpw","name":"Pictures","options":{"isReversed":false},"type":"multipleAttachments"},{"id":"fldumZe00w09RYTW6","name":"District","options":{"inverseLinkFieldId":"fldWnCJlo2z6ttT8Y","isReversed":false,"linkedTableId":"tblK6MZHez0ZvBChZ","prefersSingleRecordLink":true},"type":"multipleRecordLinks"}],"id":"tbltp8DGLhqbUmjK1","name":"Apartments","primaryFieldId":"fld1VnoyuotSTyxW1","views":[{"id":"viwQpsuEDqHFqegkp","name":"Grid view","type":"grid"}]},{"fields":[{"id":"fldEVzvQOoULO38yl","name":"Name","type":"singleLineText"},{"description":"Apartments that belong to this district","id":"fldWnCJlo2z6ttT8Y","name":"Apartments","options":{"inverseLinkFieldId":"fldumZe00w09RYTW6","isReversed":false,"linkedTableId":"tbltp8DGLhqbUmjK1","prefersSingleRecordLink":false},"type":"multipleRecordLinks"}],"id":"tblK6MZHez0ZvBChZ","name":"Districts","primaryFieldId":"fldEVzvQOoULO38yl","views":[{"id":"viwi3KXvrKug2mIBS","name":"Grid view","type":"grid"}]}]}}},"schema":{"properties":{"tables":{"items":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FTable-model"},"type":"array"}},"required":["tables"],"type":"object"}}},"description":"Placeholder Description"}},"security":[{"oauth":["schema.bases:read"]}],"summary":"Get base schema","tags":["base"],"x-airtable-auth-methods":["oauthAccessToken","personalAccessToken"]},"parameters":[{"in":"path","name":"baseId","required":true,"schema":{"pattern":"app[0-9a-zA-Z]{14}$","type":"string"}}],"post":{"description":"Creates a new table and returns the schema for the newly created table.\n\nRefer to [field types](\u002Fapi\u002Fmodel\u002Ffield-type) for supported field types, the write format for field options, and other specifics for certain field types. Supported field types have a write format shown.\n\nAt least one field must be specified. The first field in the fields array will be used as the table's primary field and must be a supported primary field type. Fields must have case-insensitive unique names within the table.\n\nA default grid view will be created with all fields visible.","operationId":"create-table","requestBody":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Success Description","summary":"Success response","value":{"description":"A to-do list of places to visit","fields":[{"description":"Name of the apartment","name":"Name","type":"singleLineText"},{"name":"Address","type":"singleLineText"},{"name":"Visited","options":{"color":"greenBright","icon":"check"},"type":"checkbox"}],"name":"Apartments"}}},"schema":{"properties":{"description":{"description":"The description for the table (optional). If present, must be a non-empty string\nno longer than 20,000 characters.","type":"string"},"fields":{"description":"A list of JSON objects representing the fields in the table. Refer to [field types](\u002Fapi\u002Fmodel\u002Ffield-type)\nfor supported field types, the write format for field options, and other specifics\nfor certain field types.","items":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FField-Config"},"type":"array"},"name":{"description":"The name for the table.","type":"string"}},"required":["name","fields"],"type":"object"}}}},"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Success Description","summary":"Success response","value":{"description":"A to-do list of places to visit","fields":[{"description":"Name of the apartment","id":"fld1VnoyuotSTyxW1","name":"Name","type":"singleLineText"},{"id":"fldoi0c3GaRQJ3xnI","name":"Address","type":"singleLineText"},{"id":"fldumZe00w09RYTW6","name":"Visited","options":{"color":"redBright","icon":"star"},"type":"checkbox"}],"id":"tbltp8DGLhqbUmjK1","name":"Apartments","primaryFieldId":"fld1VnoyuotSTyxW1","views":[{"id":"viwQpsuEDqHFqegkp","name":"Grid view","type":"grid"}]}}},"schema":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FTable-model"}}},"description":"Placeholder Description"}},"security":[{"oauth":["schema.bases:write"]}],"summary":"Create table","tags":["table"],"x-airtable-auth-methods":["oauthAccessToken","personalAccessToken"]}},"\u002Fv0\u002Fmeta\u002Fbases\u002F{baseId}\u002Ftables\u002F{tableIdOrName}":{"parameters":[{"in":"path","name":"baseId","required":true,"schema":{"pattern":"app[0-9a-zA-Z]{14}$","type":"string"}},{"in":"path","name":"tableIdOrName","required":true,"schema":{"pattern":"[^\u002F]+$","type":"string"}}],"patch":{"description":"Updates the name and\u002For description of a table. At least one of name or description must be specified.","operationId":"update-table","requestBody":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Success Response","summary":"Success response","value":{"description":"I was changed!","name":"Apartments (revised)"}}},"schema":{"properties":{"description":{"description":"The new description for the table (optional). If present, must be a string no longer than 20,000 characters.","type":"string"},"name":{"description":"The new name for the table (optional).","type":"string"}},"required":[],"type":"object"}}}},"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Success Response","summary":"Success response","value":{"description":"I was changed!","fields":[{"id":"fld1VnoyuotSTyxW1","name":"Name","type":"singleLineText"},{"id":"fldoi0c3GaRQJ3xnI","name":"Address","type":"singleLineText"},{"id":"fldumZe00w09RYTW6","name":"Visited","options":{"color":"redBright","icon":"star"},"type":"checkbox"}],"id":"tbltp8DGLhqbUmjK1","name":"Apartments (revised)","primaryFieldId":"fld1VnoyuotSTyxW1","views":[{"id":"viwQpsuEDqHFqegkp","name":"Grid view","type":"grid"}]}}},"schema":{"properties":{"description":{"type":"string"},"fields":{"items":{"properties":{"description":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"options":{"x-airtable-name":"Field options","x-airtable-redirect-to-relative-path":"field-model"},"type":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FField-Type"}},"required":["id","name"],"type":"object"},"type":"array"},"id":{"type":"string"},"name":{"type":"string"},"primaryFieldId":{"description":"The first column in the table and every view.","type":"string"},"views":{"items":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"description":"View type, `block` is Gantt View","enum":["grid","form","calendar","gallery","kanban","timeline","block"],"type":"string"},"visibleFieldIds":{"description":"Available on `grid` views only: list of visible (non-hidden) field IDs, when requested with `include` query paremeter","items":{"type":"string"},"type":"array"}},"required":["id","name","type"],"type":"object"},"type":"array"}},"required":["id","name","primaryFieldId","fields","views"],"type":"object","x-airtable-name":"Table model","x-airtable-tag":"table"}}},"description":"Placeholder Description"}},"security":[{"oauth":["schema.bases:write"]}],"summary":"Update table","tags":["table"],"x-airtable-auth-methods":["oauthAccessToken","personalAccessToken"]}},"\u002Fv0\u002Fmeta\u002Fbases\u002F{baseId}\u002Ftables\u002F{tableId}\u002Ffields":{"parameters":[{"in":"path","name":"baseId","required":true,"schema":{"pattern":"app[0-9a-zA-Z]{14}$","type":"string"}},{"in":"path","name":"tableId","required":true,"schema":{"pattern":"tbl[0-9a-zA-Z]{14}$","type":"string"}}],"post":{"description":"Creates a new column and returns the schema for the newly created column.\n\nRefer to field types for supported [field types](\u002Fapi\u002Fmodel\u002Ffield-type), the write format for field options, and other specifics for certain field types. Supported field types have a write format shown.","operationId":"create-field","requestBody":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Success Response","summary":"Success response","value":{"description":"Whether I have visited this apartment yet.","name":"Visited","options":{"color":"greenBright","icon":"check"},"type":"checkbox"}}},"schema":{"anyOf":[{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"type":{"const":"autoNumber","type":"string"}},"required":["name","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"type":{"const":"barcode","type":"string"}},"required":["name","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"type":{"const":"button","type":"string"}},"required":["name","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"options":{"properties":{"color":{"description":"The color of the checkbox.","enum":["greenBright","tealBright","cyanBright","blueBright","purpleBright","pinkBright","redBright","orangeBright","yellowBright","grayBright"],"type":"string"},"icon":{"description":"The icon name of the checkbox.","enum":["check","xCheckbox","star","heart","thumbsUp","flag","dot"],"type":"string"}},"required":["color","icon"],"type":"object"},"type":{"const":"checkbox","type":"string"}},"required":["name","options","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"type":{"const":"createdBy","type":"string"}},"required":["name","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"options":{"properties":{"result":{"anyOf":[{"properties":{"options":{"properties":{"dateFormat":{"properties":{"format":{"description":"`format` is always provided when reading.\n(`l` for local, `LL` for friendly, `M\u002FD\u002FYYYY` for us, `D\u002FM\u002FYYYY` for european, `YYYY-MM-DD` for iso)","enum":["l","LL","M\u002FD\u002FYYYY","D\u002FM\u002FYYYY","YYYY-MM-DD"],"type":"string"},"name":{"enum":["local","friendly","us","european","iso"],"type":"string"}},"required":["name","format"],"type":"object"}},"required":["dateFormat"],"type":"object"},"type":{"const":"date","type":"string"}},"required":["type","options"],"type":"object","x-airtable-name":"Date field config","x-airtable-redirect-to-relative-path":"field-model#dateonly"},{"properties":{"options":{"properties":{"dateFormat":{"properties":{"format":{"description":"`format` is always provided when reading.\n(`l` for local, `LL` for friendly, `M\u002FD\u002FYYYY` for us, `D\u002FM\u002FYYYY` for european, `YYYY-MM-DD` for iso)","enum":["l","LL","M\u002FD\u002FYYYY","D\u002FM\u002FYYYY","YYYY-MM-DD"],"type":"string"},"name":{"enum":["local","friendly","us","european","iso"],"type":"string"}},"required":["name","format"],"type":"object"},"timeFormat":{"properties":{"format":{"enum":["h:mma","HH:mm"],"type":"string"},"name":{"enum":["12hour","24hour"],"type":"string"}},"required":["name","format"],"type":"object"},"timeZone":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FTimezone"}},"required":["dateFormat","timeFormat","timeZone"],"type":"object"},"type":{"const":"dateTime","type":"string"}},"required":["type","options"],"type":"object","x-airtable-name":"Date-time field config","x-airtable-redirect-to-relative-path":"field-model#dateandtime"}],"description":"This will always be a `date` or `dateTime` field config."}},"type":"object"},"type":{"const":"createdTime","type":"string"}},"required":["name","options","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"options":{"properties":{"isValid":{"description":"`false` when recordLinkFieldId is null, e.g. the referenced column was deleted.","type":"boolean"},"recordLinkFieldId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["isValid"],"type":"object"},"type":{"const":"count","type":"string"}},"required":["name","options","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"options":{"properties":{"formula":{"description":"The formula including fields referenced by their IDs. For example, LEFT(4, {Birthday})\nin the Airtable.com formula editor will be returned as LEFT(4, {fldXXX}) via API.","type":"string"},"isValid":{"description":"`false` if the formula contains an error.","type":"boolean"},"referencedFieldIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"All fields in the record that are used in the formula."},"result":{"anyOf":[{"$ref":"#\u002Fcomponents\u002Fschemas\u002FField-type-and-options"},{"type":"null"}],"description":"The resulting field type and options returned by the formula. See other field\ntype configs on this page for the possible values. Can be null if invalid."}},"required":["isValid","formula","referencedFieldIds","result"],"type":"object"},"type":{"const":"formula","type":"string"}},"required":["name","options","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"options":{"properties":{"isValid":{"description":"False if this formula\u002Ffield configuation has an error","type":"boolean"},"referencedFieldIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"The fields to check the last modified time of"},"result":{"anyOf":[{"properties":{"options":{"properties":{"dateFormat":{"properties":{"format":{"description":"`format` is always provided when reading.\n(`l` for local, `LL` for friendly, `M\u002FD\u002FYYYY` for us, `D\u002FM\u002FYYYY` for european, `YYYY-MM-DD` for iso)","enum":["l","LL","M\u002FD\u002FYYYY","D\u002FM\u002FYYYY","YYYY-MM-DD"],"type":"string"},"name":{"enum":["local","friendly","us","european","iso"],"type":"string"}},"required":["name","format"],"type":"object"}},"required":["dateFormat"],"type":"object"},"type":{"const":"date","type":"string"}},"required":["type","options"],"type":"object","x-airtable-name":"Date field config","x-airtable-redirect-to-relative-path":"field-model#dateonly"},{"properties":{"options":{"properties":{"dateFormat":{"properties":{"format":{"description":"`format` is always provided when reading.\n(`l` for local, `LL` for friendly, `M\u002FD\u002FYYYY` for us, `D\u002FM\u002FYYYY` for european, `YYYY-MM-DD` for iso)","enum":["l","LL","M\u002FD\u002FYYYY","D\u002FM\u002FYYYY","YYYY-MM-DD"],"type":"string"},"name":{"enum":["local","friendly","us","european","iso"],"type":"string"}},"required":["name","format"],"type":"object"},"timeFormat":{"properties":{"format":{"enum":["h:mma","HH:mm"],"type":"string"},"name":{"enum":["12hour","24hour"],"type":"string"}},"required":["name","format"],"type":"object"},"timeZone":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FTimezone"}},"required":["dateFormat","timeFormat","timeZone"],"type":"object"},"type":{"const":"dateTime","type":"string"}},"required":["type","options"],"type":"object","x-airtable-name":"Date-time field config","x-airtable-redirect-to-relative-path":"field-model#dateandtime"},{"type":"null"}],"description":"This will always be a `date` or `dateTime` field config."}},"required":["isValid","referencedFieldIds","result"],"type":"object"},"type":{"const":"lastModifiedTime","type":"string"}},"required":["name","options","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"type":{"const":"lastModifiedBy","type":"string"}},"required":["name","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"options":{"properties":{"fieldIdInLinkedTable":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The field in the linked table that this field is looking up."},"isValid":{"description":"Is the field currently valid (e.g. false if the linked record field has\nbeen deleted)","type":"boolean"},"recordLinkFieldId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The linked record field in the current table."},"result":{"anyOf":[{"$ref":"#\u002Fcomponents\u002Fschemas\u002FField-type-and-options"},{"type":"null"}],"description":"The field type and options inside of the linked table. See other field\ntype configs on this page for the possible values. Can be null if invalid."}},"required":["isValid","recordLinkFieldId","fieldIdInLinkedTable","result"],"type":"object"},"type":{"const":"lookup","type":"string"}},"required":["name","options","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"options":{"properties":{"precision":{"description":"Indicates the number of digits shown to the right of the decimal point for this field. (0-8 inclusive)","type":"number"}},"required":["precision"],"type":"object"},"type":{"const":"number","type":"string"}},"required":["name","options","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"options":{"properties":{"precision":{"description":"Indicates the number of digits shown to the right of the decimal point for this field. (0-8 inclusive)","type":"number"}},"required":["precision"],"type":"object"},"type":{"const":"percent","type":"string"}},"required":["name","options","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"options":{"properties":{"precision":{"description":"Indicates the number of digits shown to the right of the decimal point for this field. (0-7 inclusive)","type":"number"},"symbol":{"description":"Currency symbol to use.","type":"string"}},"required":["precision","symbol"],"type":"object"},"type":{"const":"currency","type":"string"}},"required":["name","options","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"options":{"properties":{"durationFormat":{"enum":["h:mm","h:mm:ss","h:mm:ss.S","h:mm:ss.SS","h:mm:ss.SSS"],"type":"string"}},"required":["durationFormat"],"type":"object"},"type":{"const":"duration","type":"string"}},"required":["name","options","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"type":{"const":"multilineText","type":"string"}},"required":["name","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"type":{"const":"phoneNumber","type":"string"}},"required":["name","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"options":{"properties":{"color":{"description":"The color of selected icons.","enum":["yellowBright","orangeBright","redBright","pinkBright","purpleBright","blueBright","cyanBright","tealBright","greenBright","grayBright"],"type":"string"},"icon":{"description":"The icon name used to display the rating.","enum":["star","heart","thumbsUp","flag","dot"],"type":"string"},"max":{"description":"The maximum value for the rating, from 1 to 10 inclusive.","type":"number"}},"required":["color","icon","max"],"type":"object"},"type":{"const":"rating","type":"string"}},"required":["name","options","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"type":{"const":"richText","type":"string"}},"required":["name","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"options":{"properties":{"fieldIdInLinkedTable":{"description":"The id of the field in the linked table","type":"string"},"isValid":{"type":"boolean"},"recordLinkFieldId":{"description":"The linked field id","type":"string"},"referencedFieldIds":{"description":"The ids of any fields referenced in the rollup formula","items":{"type":"string"},"type":"array"},"result":{"anyOf":[{"$ref":"#\u002Fcomponents\u002Fschemas\u002FField-type-and-options"},{"type":"null"}],"description":"The resulting field type and options for the rollup. See other field\ntype configs on this page for the possible values. Can be null if invalid."}},"type":"object"},"type":{"const":"rollup","type":"string"}},"required":["name","options","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"type":{"const":"singleLineText","type":"string"}},"required":["name","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"type":{"const":"email","type":"string"}},"required":["name","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"type":{"const":"url","type":"string"}},"required":["name","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"options":{"properties":{"choices":{"items":{"properties":{"color":{"description":"Optional when the select field is configured to not use colors.\n\nAllowed values: \"blueLight2\", \"cyanLight2\", \"tealLight2\", \"greenLight2\", \"yellowLight2\", \"orangeLight2\", \"redLight2\", \"pinkLight2\", \"purpleLight2\", \"grayLight2\", \"blueLight1\", \"cyanLight1\", \"tealLight1\", \"greenLight1\", \"yellowLight1\", \"orangeLight1\", \"redLight1\", \"pinkLight1\", \"purpleLight1\", \"grayLight1\", \"blueBright\", \"cyanBright\", \"tealBright\", \"greenBright\", \"yellowBright\", \"orangeBright\", \"redBright\", \"pinkBright\", \"purpleBright\", \"grayBright\", \"blueDark1\", \"cyanDark1\", \"tealDark1\", \"greenDark1\", \"yellowDark1\", \"orangeDark1\", \"redDark1\", \"pinkDark1\", \"purpleDark1\", \"grayDark1\"","type":"string"},"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"type":"object"},"type":"array"}},"required":["choices"],"type":"object"},"type":{"const":"externalSyncSource","type":"string"}},"required":["name","options","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"options":{"properties":{"prompt":{"description":"The prompt that is used to generate the results in the AI field, additional object\ntypes may be added in the future. Currently, this is an array of strings or objects that identify any fields interpolated into the prompt.\n\nThe prompt will not currently be provided if this field config is within another\nfields configuration (like a lookup field)","items":{"anyOf":[{"type":"string"},{"properties":{"field":{"properties":{"fieldId":{"type":"string"}},"required":["fieldId"],"type":"object"}},"required":["field"],"type":"object"}]},"type":"array"},"referencedFieldIds":{"description":"The other fields in the record that are used in the ai field\n\nThe referencedFieldIds will not currently be provided if this field config is within another\nfields configuration (like a lookup field)","items":{"type":"string"},"type":"array"}},"type":"object"},"type":{"const":"aiText","type":"string"}},"required":["name","options","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"options":{"properties":{"linkedTableId":{"description":"The ID of the table this field links to","type":"string"},"viewIdForRecordSelection":{"description":"The ID of the view in the linked table\nto use when showing a list of records to select from","type":"string"}},"required":["linkedTableId"],"type":"object"},"type":{"const":"multipleRecordLinks","type":"string"}},"required":["name","options","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"options":{"properties":{"choices":{"items":{"properties":{"color":{"description":"Optional when creating an option.","type":"string"},"id":{"description":"This is not specified when creating new options, useful when specifing existing\noptions (for example: reordering options, keeping old options and adding new ones, etc)","type":"string"},"name":{"type":"string"}},"required":["name"],"type":"object"},"type":"array"}},"required":["choices"],"type":"object"},"type":{"const":"singleSelect","type":"string"}},"required":["name","options","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"options":{"properties":{"choices":{"items":{"properties":{"color":{"description":"Optional when creating an option.","type":"string"},"id":{"description":"This is not specified when creating new options, useful when specifing existing\noptions (for example: reordering options, keeping old options and adding new ones, etc)","type":"string"},"name":{"type":"string"}},"required":["name"],"type":"object"},"type":"array"}},"required":["choices"],"type":"object"},"type":{"const":"multipleSelects","type":"string"}},"required":["name","options","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"options":{"type":"object"},"type":{"const":"singleCollaborator","type":"string"}},"required":["name","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"options":{"type":"object"},"type":{"const":"multipleCollaborators","type":"string"}},"required":["name","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"options":{"properties":{"dateFormat":{"properties":{"format":{"description":"Format is optional when writing, but it must match\nthe corresponding name if provided.\n\n(`l` for local, `LL` for friendly, `M\u002FD\u002FYYYY` for us, `D\u002FM\u002FYYYY` for european, `YYYY-MM-DD` for iso)","enum":["l","LL","M\u002FD\u002FYYYY","D\u002FM\u002FYYYY","YYYY-MM-DD"],"type":"string"},"name":{"enum":["local","friendly","us","european","iso"],"type":"string"}},"required":["name"],"type":"object"}},"required":["dateFormat"],"type":"object"},"type":{"const":"date","type":"string"}},"required":["name","options","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"options":{"properties":{"dateFormat":{"properties":{"format":{"description":"Format is optional when writing, but it must match\nthe corresponding name if provided.\n\n(`l` for local, `LL` for friendly, `M\u002FD\u002FYYYY` for us, `D\u002FM\u002FYYYY` for european, `YYYY-MM-DD` for iso)","enum":["l","LL","M\u002FD\u002FYYYY","D\u002FM\u002FYYYY","YYYY-MM-DD"],"type":"string"},"name":{"enum":["local","friendly","us","european","iso"],"type":"string"}},"required":["name"],"type":"object"},"timeFormat":{"properties":{"format":{"enum":["h:mma","HH:mm"],"type":"string"},"name":{"enum":["12hour","24hour"],"type":"string"}},"required":["name"],"type":"object"},"timeZone":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FTimezone"}},"required":["dateFormat","timeFormat","timeZone"],"type":"object"},"type":{"const":"dateTime","type":"string"}},"required":["name","options","type"],"type":"object"},{"properties":{"description":{"description":"The description for the field (optional). If present, must be a non-empty string no longer than 20,000 characters.","type":"string"},"name":{"description":"The name for the field.","type":"string"},"options":{"properties":{"isReversed":{"type":"boolean"}},"required":["isReversed"],"type":"object"},"type":{"const":"multipleAttachments","type":"string"}},"required":["name","type"],"type":"object"}],"description":"This identical to Field type and options, with\nan additional `name` and `description` property on all types","x-airtable-name":"Field model with name","x-airtable-redirect-to-relative-path":"field-model"}}}},"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Success Response","summary":"Success response","value":{"description":"Whether I have visited this apartment yet.","id":"fldumZe00w09RYTW6","name":"Visited","options":{"color":"redBright","icon":"star"},"type":"checkbox"}}},"schema":{"properties":{"description":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"options":{"x-airtable-name":"Field options","x-airtable-redirect-to-relative-path":"field-model"},"type":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FField-Type"}},"required":["id","name"],"type":"object"}}},"description":"Placeholder Description"}},"security":[{"oauth":["schema.bases:write"]}],"summary":"Create field","tags":["column"],"x-airtable-auth-methods":["oauthAccessToken","personalAccessToken"]}},"\u002Fv0\u002Fmeta\u002Fbases\u002F{baseId}\u002Ftables\u002F{tableId}\u002Ffields\u002F{columnId}":{"parameters":[{"in":"path","name":"baseId","required":true,"schema":{"pattern":"app[0-9a-zA-Z]{14}$","type":"string"}},{"in":"path","name":"tableId","required":true,"schema":{"pattern":"tbl[0-9a-zA-Z]{14}$","type":"string"}},{"in":"path","name":"columnId","required":true,"schema":{"pattern":"fld[0-9a-zA-Z]{14}$","type":"string"}}],"patch":{"description":"Updates the name and\u002For description of a field. At least one of name or description must be specified.","operationId":"update-field","requestBody":{"content":{"application\u002Fjson":{"examples":{"Success Response":{"description":"Success Response","summary":"Success Response","value":{"description":"I was changed!","name":"Apartments (revised)"}}},"schema":{"properties":{"description":{"description":"The new description for the field (optional). If present, must be a string no longer than 20,000 characters.","type":"string"},"name":{"description":"The new name for the field (optional).","type":"string"}},"required":[],"type":"object"}}}},"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success Response":{"description":"Success Response","summary":"Success Response","value":{"description":"I was changed!","id":"fldoi0c3GaRQJ3xnI","name":"Name (revised)","type":"singleLineText"}}},"schema":{"properties":{"description":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"options":{"x-airtable-name":"Field options","x-airtable-redirect-to-relative-path":"field-model"},"type":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FField-Type"}},"required":["id","name"],"type":"object"}}},"description":"Placeholder Description"}},"security":[{"oauth":["schema.bases:write"]}],"summary":"Update field","tags":["column"],"x-airtable-auth-methods":["oauthAccessToken","personalAccessToken"]}},"\u002Fv0\u002Fmeta\u002Fbases\u002F{baseId}\u002Fviews":{"get":{"description":"Lists basic information of base views.","operationId":"list-views","parameters":[{"in":"query","name":"include","schema":{"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)","items":{"const":"visibleFieldIds","type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success Response":{"description":"Success Description","summary":"Success Response","value":{"views":[{"id":"viwQpsuEDqHFqegkp","name":"My Grid View","personalForUserId":"usrL2PNC5o3H4lBEi","type":"grid"},{"id":"viwi3KXvrKug2mIBS","name":"Project Plan (Gantt Chart)","type":"block"}]}}},"schema":{"properties":{"views":{"items":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"personalForUserId":{"description":"Present if the view is personal for a user.","type":"string"},"type":{"description":"Gantt views have a type of 'block'","enum":["grid","form","calendar","gallery","kanban","timeline","block"],"type":"string"},"visibleFieldIds":{"description":"Available on `grid` views only: list of visible (non-hidden) field IDs, when requested with `include` query paremeter","items":{"type":"string"},"type":"array"}},"required":["id","name","type"],"type":"object"},"type":"array"}},"required":["views"],"type":"object"}}},"description":"Placeholder Description"}},"security":[{"oauth":["workspacesAndBases:read"]}],"summary":"List views","tags":["view"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"]},"parameters":[{"in":"path","name":"baseId","required":true,"schema":{"pattern":"app[0-9a-zA-Z]{14}$","type":"string"}}]},"\u002Fv0\u002Fmeta\u002Fbases\u002F{baseId}\u002Fviews\u002F{viewId}":{"delete":{"description":"Delete a view.","operationId":"delete-view","parameters":[],"responses":{"200":{"content":{"application\u002Fjson":{"schema":{"type":"null"}}},"description":"Placeholder Description"}},"security":[{"oauth":["workspacesAndBases:write"]}],"summary":"Delete view","tags":["view"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"],"x-airtable-override-documentation-scopes-and-user-role":{"userRoleMarkdown":"Base editor"}},"get":{"description":"Get basic information of base view.","operationId":"get-view-metadata","parameters":[{"in":"query","name":"include","schema":{"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)","items":{"const":"visibleFieldIds","type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success Response":{"description":"Success Response","summary":"Success Response","value":{"id":"viwQpsuEDqHFqegkp","name":"My Grid View","personalForUserId":"usrL2PNC5o3H4lBEi","type":"grid"}}},"schema":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"personalForUserId":{"description":"Present if the view is personal for a user.","type":"string"},"type":{"description":"Gantt views have a type of 'block'","enum":["grid","form","calendar","gallery","kanban","timeline","block"],"type":"string"},"visibleFieldIds":{"description":"Available on `grid` views only: list of visible (non-hidden) field IDs, when requested with `include` query paremeter","items":{"type":"string"},"type":"array"}},"required":["id","name","type"],"type":"object"}}},"description":"Placeholder Description"}},"security":[{"oauth":["workspacesAndBases:read"]}],"summary":"Get view metadata","tags":["view"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"]},"parameters":[{"in":"path","name":"baseId","required":true,"schema":{"pattern":"app[0-9a-zA-Z]{14}$","type":"string"}},{"in":"path","name":"viewId","required":true,"schema":{"pattern":"viw[0-9a-zA-Z]{14}$","type":"string"}}]},"\u002Fv0\u002Fmeta\u002FenterpriseAccounts\u002F{enterpriseAccountId}":{"get":{"description":"Returns basic information relevant to the enterprise account.","operationId":"get-enterprise","parameters":[{"in":"query","name":"include","schema":{"description":"If specified, aggregated and\u002For descendants keys will be included in the response object.\nOtherwise, it will be left out.","items":{"enum":["aggregated","descendants"],"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Example response":{"description":"Simple example","summary":"Example response","value":{"createdTime":"2019-01-03T12:33:12.421Z","descendantEnterpriseAccountIds":["entJ9ZQ5vz9ZQ5vz9"],"emailDomains":[{"emailDomain":"foobar.com","isSsoRequired":true}],"groupIds":["ugp1mKGb3KXUyQfOZ","ugpR8ZT9KtIgp8Bh3"],"id":"entUBq2RGdihxl3vU","rootEnterpriseAccountId":"entUBq2RGdihxl3vU","userIds":["usrL2PNC5o3H4lBEi","usrsOEchC9xuwRgKk","usrGcrteE5fUMqq0R"],"workspaceIds":["wspmhESAta6clCCwF","wspHvvm4dAktsStZH"]}}},"schema":{"properties":{"aggregated":{"description":"The aggregated values across the enterprise account and its descendants.\nOnly returned when the enterprise account has the Enterprise Hub feature enabled.","properties":{"groupIds":{"description":"A list of groups that belong to the enterprise account and its descendants.","items":{"description":"A user group ID","type":"string"},"type":"array"},"userIds":{"description":"A list of users including all the collaborators with the enterprise account and its descendants.","items":{"description":"A user ID","type":"string"},"type":"array"},"workspaceIds":{"description":"A list of workspaces that are managed by the enterprise account and its descendants.","items":{"type":"string"},"type":"array"}},"required":["userIds","groupIds","workspaceIds"],"type":"object"},"createdTime":{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},"descendantEnterpriseAccountIds":{"description":"A list of descendant org unit's belonging to the enterprise account.","items":{"type":"string"},"type":"array"},"descendants":{"additionalProperties":{"properties":{"groupIds":{"items":{"description":"A user group ID","type":"string"},"type":"array"},"userIds":{"items":{"description":"A user ID","type":"string"},"type":"array"},"workspaceIds":{"items":{"type":"string"},"type":"array"}},"required":["userIds","groupIds","workspaceIds"],"type":"object"},"description":"The enterprise account values per descendant enterprise account.\nOnly returned when the enterprise account has the Enterprise Hub feature enabled.","type":"object"},"emailDomains":{"description":"A list of email domains associated to the enterprise account.","items":{"properties":{"emailDomain":{"type":"string"},"isSsoRequired":{"type":"boolean"}},"required":["emailDomain","isSsoRequired"],"type":"object"},"type":"array"},"groupIds":{"description":"A list of groups that belong to the enterprise account.","items":{"description":"A user group ID","type":"string"},"type":"array"},"id":{"type":"string"},"rootEnterpriseAccountId":{"description":"The ID of this account's root enterprise account. For accounts that are not part of an Enterprise Hub, this is the same as the account's own ID.","type":"string"},"userIds":{"description":"A list of users including all the collaborators of all of the enterprise account's workspaces, bases, and interfaces.","items":{"description":"A user ID","type":"string"},"type":"array"},"workspaceIds":{"description":"A list of workspaces that are managed by the enterprise account.","items":{"type":"string"},"type":"array"}},"required":["id","rootEnterpriseAccountId","userIds","groupIds","workspaceIds","emailDomains","createdTime","descendantEnterpriseAccountIds"],"type":"object"}}},"description":"Placeholder Description"}},"security":[{"oauth":["enterprise.account:read"]}],"summary":"Get enterprise","tags":["enterprise"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"]},"parameters":[{"in":"path","name":"enterpriseAccountId","required":true,"schema":{"pattern":"ent[0-9a-zA-Z]{14}$","type":"string"}}]},"\u002Fv0\u002Fmeta\u002FenterpriseAccounts\u002F{enterpriseAccountId}\u002FauditLogEvents":{"get":{"description":"Retrieve audit log events for an enterprise. By default, this will walk all the data we're currently storing and continue walking data into the future.","operationId":"audit-log-events","parameters":[{"in":"query","name":"startTime","schema":{"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.","type":"string"}},{"in":"query","name":"endTime","schema":{"description":"Latest audit log event to retrieve (exclusive), in ISO 8601 date time format. Optional. Defaults to now.","type":"string"}},{"in":"query","name":"originatingUserId","schema":{"anyOf":[{"description":"A user ID","type":"string"},{"items":{"description":"A user ID","type":"string"},"type":"array"}],"description":"Retrieve audit log events originating from the provided user ID or IDs (maximum 100). Optional."}},{"in":"query","name":"eventType","schema":{"anyOf":[{"$ref":"#\u002Fcomponents\u002Fschemas\u002FAudit-log-event-types"},{"items":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FAudit-log-event-types"},"type":"array"}],"description":"Retrieve audit log events falling under the provided event type or event types (maximum 100). Optional."}},{"in":"query","name":"modelId","schema":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"}],"description":"Retrieve audit log events taking action on, or involving, the provided model ID or IDs (maximum 100). Optional."}},{"in":"query","name":"pageSize","schema":{"description":"The number of events per page. Maximum value of 1000; defaults to 10.","type":"number"}},{"in":"query","name":"sortOrder","schema":{"description":"Sort the events by timestamp in ascending or descending order. Defaults to descending.","enum":["descending","ascending"],"type":"string"}},{"in":"query","name":"previous","schema":{"description":"If there are older items to retrieve, a **previous** is returned.\nPass the **previous** from a prior call to retrieve the next-oldest page of items.\nYou may pass the special value `null` to indicate \"use the default behavior\", which operates identically to omitting the **previous** parameter entirely.","type":"string"}},{"in":"query","name":"next","schema":{"description":"If there are newer items to retrieve, a **next** is returned.\nPass the **next** from a prior call to retrieve the next-newest page of items.\nYou may pass the special value `null` to indicate \"use the default behavior\", which operates identically to omitting the **next** parameter entirely.","type":"string"}},{"in":"query","name":"category","schema":{"anyOf":[{"enum":["base","baseCollaboration","groups","role","share","user","twoFactorAuthentication","oauth","enterprise","enterpriseSettings","enterpriseLicenses","managedApps","components","publishedDataSets","dataTable","workspace","workspaceCollaboration","interface","standaloneForms","interfaceCollaboration","view","ai","solution"],"type":"string"},{"items":{"enum":["base","baseCollaboration","groups","role","share","user","twoFactorAuthentication","oauth","enterprise","enterpriseSettings","enterpriseLicenses","managedApps","components","publishedDataSets","dataTable","workspace","workspaceCollaboration","interface","standaloneForms","interfaceCollaboration","view","ai","solution"],"type":"string"},"type":"array"}]}}],"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Success Response","summary":"Success response","value":{"events":[{"action":"createBase","actor":{"type":"user","user":{"email":"foo@bar.com","id":"usrL2PNC5o3H4lBEi","name":"Jane Doe"}},"context":{"actionId":"actxr1mLqZz1T35FA","baseId":"appLkNDICXNqxSDhG","enterpriseAccountId":"entUBq2RGdihxl3vU","interfaceId":"pbdyGA3PsOziEHPDE","workspaceId":"wspmhESAta6clCCwF"},"id":"01FYFFDE39BDDBC0HWK51R6GPF","modelId":"appLkNDICXNqxSDhG","modelType":"base","origin":{"ipAddress":"1.2.3.4","sessionId":"sesE3ulSADiRNhqAv","userAgent":"Mozilla\u002F5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit\u002F537.36 (KHTML, like Gecko) Chrome\u002F107.0.0.0 Safari\u002F537.36"},"payload":{"name":"My newly created base!"},"payloadVersion":"1.0","timestamp":"2022-02-01T21:25:05.663Z"}],"pagination":{"next":"MDFHUk5OMlM4MFhTNkY0R0M2QVlZTVZNNDQ=","previous":"MDFHUk5ITVhNMEE4UFozTlg1SlFaRlMyOFM="}}}},"schema":{"properties":{"events":{"description":"Events are returned newest to oldest.","items":{"properties":{"action":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FAudit-log-event-types"},"actor":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FAudit-log-actor"},"context":{"properties":{"actionId":{"type":"string"},"baseId":{"description":"Base ID, a unique identifier for a base.","type":"string"},"descendantEnterpriseAccountId":{"type":"string"},"enterpriseAccountId":{"type":"string"},"interfaceId":{"type":"string"},"workspaceId":{"type":"string"}},"required":["enterpriseAccountId","actionId"],"type":"object"},"id":{"type":"string"},"modelId":{"type":"string"},"modelType":{"enum":["base","attachment","extension_installation","interface","page","page_element","record","share","invite","two_factor_strategy","user","group","view","workspace","enterprise","table","oauth_access_token","feature_kit_installation","managed_app","managed_app_release","component","component_release","data_table","data_table_import","published_dataset","role"],"type":"string"},"origin":{"properties":{"ipAddress":{"type":"string"},"oauthAccessTokenId":{"type":"string"},"personalAccessTokenId":{"type":"string"},"sessionId":{"type":"string"},"userAgent":{"type":"string"}},"required":["ipAddress","userAgent"],"type":"object"},"payload":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FAudit-log-event-payloads"},"payloadVersion":{"enum":["1.0","1.1","2.0","3.0"],"type":"string"},"timestamp":{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"}},"required":["id","timestamp","action","payloadVersion","payload","modelId","modelType","origin","context","actor"],"type":"object"},"type":"array"},"pagination":{"description":"Contains pagination tokens (if existing).","properties":{"next":{"description":"Pagination token to retrieve the next-newest page of available items.\nIf an endTime was provided in the query, this value will be non-null if there exist any\nnewer items to retrieve. If an endTime was not provided in the query, this value will\nalways be present to provide a starting point from which to continue consuming future\naudit log events. To retrieve the next-newest page of available items, repeat the request\nthat generated _this_ page of items, but supply this value as the **next** query parameter.","type":["string","null"]},"previous":{"description":"Pagination token used to retrieve the next-oldest page of available items.\nThis value will be non-null in the response only if there exist any older items to retrieve.\nTo retrieve the next-oldest page of available items, repeat the request that generated _this_\npage of items, but supply this value as the **previous** query parameter.","type":["string","null"]}},"required":["previous","next"],"type":"object"}},"required":["events","pagination"],"type":"object"}}},"description":"Placeholder Description"},"422":{"content":{"application\u002Fjson":{"examples":{"Invalid endTime (too far in the future)":{"description":"Invalid **endTime**. See error message for exact reason.","summary":"Invalid endTime (too far in the future)","value":{"error":{"message":"Provided endTime is too far in the future","type":"INVALID_TIME_RANGE"}}},"Invalid endTime (too far in the past)":{"description":"Invalid **endTime**. See error message for exact reason.","summary":"Invalid endTime (too far in the past)","value":{"error":{"message":"Provided endTime is before oldest queryable time","type":"INVALID_TIME_RANGE"}}},"Invalid filter":{"description":"Invalid **filter**. See error message for exact reason.","summary":"Invalid filter","value":{"error":{"message":"Maximum filter count per parameter is 100","type":"TOO_MANY_FILTERS"}}},"Invalid pageSize":{"description":"Invalid **pageSize**. See error message for exact reason.","summary":"Invalid pageSize","value":{"error":{"message":"Maximum pageSize is 1000","type":"INVALID_PAGE_SIZE_ARGUMENT"}}},"Invalid pagination token":{"description":"Invalid **pagination**. See error message for exact reason.","summary":"Invalid pagination token","value":{"error":{"message":"Invalid pagination token","type":"INVALID_PAGINATION_TOKEN"}}},"Invalid pagination token (multiple tokens received)":{"description":"Invalid **pagination**. See error message for exact reason.","summary":"Invalid pagination token (multiple tokens received)","value":{"error":{"message":"Multiple pagination tokens received","type":"MULTIPLE_PAGINATION_TOKENS_RECEIVED"}}},"Invalid pagination token (out of range)":{"description":"Invalid **pagination**. See error message for exact reason.","summary":"Invalid pagination token (out of range)","value":{"error":{"message":"Pagination token is invalid for this query","type":"INVALID_PAGINATION_TOKEN"}}},"Invalid startTime (too far in the future)":{"description":"Invalid **startTime**. See error message for exact reason.","summary":"Invalid startTime (too far in the future)","value":{"error":{"message":"Provided startTime is in the future","type":"INVALID_TIME_RANGE"}}},"Invalid startTime (too far in the past)":{"description":"Invalid **startTime**. See error message for exact reason.","summary":"Invalid startTime (too far in the past)","value":{"error":{"message":"Provided startTime is too far in the past. Audit log events are stored for 180 days.","type":"INVALID_TIME_RANGE"}}},"Invalid time":{"description":"Invalid **startTime** or **endTime**. See error message for exact reason.","summary":"Invalid time","value":{"error":{"message":"startTime cannot be same or after endTime","type":"INVALID_TIME_RANGE"}}}}}},"description":"Placeholder Description"}},"security":[{"oauth":["enterprise.auditLogs:read"]}],"summary":"Audit log events","tags":["auditLogs"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"]},"parameters":[{"in":"path","name":"enterpriseAccountId","required":true,"schema":{"pattern":"ent[0-9a-zA-Z]{14}$","type":"string"}}]},"\u002Fv0\u002Fmeta\u002FenterpriseAccounts\u002F{enterpriseAccountId}\u002FauditLogs":{"get":{"description":"**NOTE:** Use of this API is discouraged for new use cases. Prefer to use the [audit log events API](\u002Fapi\u002Faudit-logs-overview) instead.\n\nRetrieve all audit log requests.","operationId":"list-audit-log-requests","parameters":[{"in":"query","name":"pageSize","schema":{"description":"The number of records per page. Maximum value of 100; defaults to 10.","type":"number"}},{"in":"query","name":"offset","schema":{"description":"If there may be more to retrieve, an **offset** is returned.\nPass the **offset** to the next call to retrieve the next page. Do not pass **offset** when retrieving the first page.","type":"number"}}],"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Success Response","summary":"Success response","value":{"auditLogs":[{"createdByUserId":"usrL2PNC5o3H4lBEi","createdTime":"2021-01-01T00:00:00.000Z","filter":"appLkNDICXNqxSDhG","id":"ealLvFqm3oJNxg30m","state":"pending","timePeriod":"2021-01"}],"offset":10}}},"schema":{"properties":{"auditLogs":{"items":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FAudit-log"},"type":"array"},"offset":{"type":"number"}},"required":["auditLogs"],"type":"object"}}},"description":"Placeholder Description"}},"security":[{"oauth":["enterprise.auditLogs:read"]}],"summary":"List audit log requests","tags":["auditing"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"]},"parameters":[{"in":"path","name":"enterpriseAccountId","required":true,"schema":{"pattern":"ent[0-9a-zA-Z]{14}$","type":"string"}}],"post":{"description":"**NOTE:** Use of this API is discouraged for new use cases. Prefer to use the [audit log events API](\u002Fapi\u002Faudit-logs-overview) instead.\n\nCreate an audit log request. This starts the processing necessary to retrive the logs.\n\nThe response includes an `id`, which is then used to [check the status of and download](\u002Fapi\u002Fget-audit-log-request) your logs.","operationId":"create-audit-log-request","requestBody":{"content":{"application\u002Fjson":{"examples":{"Success Response":{"description":"Success Response","summary":"Success Response","value":{"filter":"appLkNDICXNqxSDhG","timePeriod":"2021-01"}}},"schema":{"properties":{"filter":{"description":"An optional filter may be supplied. The filter value may be any of:\n\n- User ID\n- Workspace ID\n- Base ID\n- Table ID\n- IPv4 address (**1.2.3.4**)","type":"string"},"timePeriod":{"description":"The time period (specific month or day) for which you want to retrieve audit logs for.\nMust be in either **YYYY-MM** or **YYYY-MM-DD** format and within the last 180 days.","type":"string"}},"required":["timePeriod"],"type":"object"}}}},"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success Response":{"description":"Success Response","summary":"Success Response","value":{"createdByUserId":"usrL2PNC5o3H4lBEi","createdTime":"2021-01-01T00:00:00.000Z","filter":"appLkNDICXNqxSDhG","id":"ealLvFqm3oJNxg30m","state":"pending","timePeriod":"2021-01"}}},"schema":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FAudit-log"}}},"description":"Placeholder Description"}},"security":[{"oauth":["enterprise.auditLogs:read"]}],"summary":"Create audit log request","tags":["auditing"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"]}},"\u002Fv0\u002Fmeta\u002FenterpriseAccounts\u002F{enterpriseAccountId}\u002FauditLogs\u002F{enterpriseAuditLogTaskId}":{"get":{"description":"**NOTE:** Use of this API is discouraged for new use cases. Prefer to use the [audit log events API](\u002Fapi\u002Faudit-logs-overview) instead.\n\nRetrieve a specific audit log request.","operationId":"get-audit-log-request","parameters":[],"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success response, done":{"description":"Success Response, Processing","summary":"Success response, done","value":{"createdByUserId":"usrL2PNC5o3H4lBEi","createdTime":"2021-01-01T00:00:00.000Z","data":{"expirationTime":"2021-01-01T00:00:00.000Z","logFileUrls":["https:\u002F\u002Fairtable-sensitive-customer-data-development.s3.amazonaws.com\u002F..."]},"id":"ealLvFqm3oJNxg30m","state":"done","timePeriod":"2021-01"}},"Success response, error":{"description":"Success Response, Processing","summary":"Success response, error","value":{"createdByUserId":"usrL2PNC5o3H4lBEi","createdTime":"2021-01-01T00:00:00.000Z","errorMessage":"error message","id":"ealLvFqm3oJNxg30m","state":"error","timePeriod":"2021-01"}},"Success response, pending":{"description":"Success Response, Processing","summary":"Success response, pending","value":{"createdByUserId":"usrL2PNC5o3H4lBEi","createdTime":"2021-01-01T00:00:00.000Z","filter":"appLkNDICXNqxSDhG","id":"ealLvFqm3oJNxg30m","state":"pending","timePeriod":"2021-01"}},"Success response, processing":{"description":"Success Response, Processing","summary":"Success response, processing","value":{"createdByUserId":"usrL2PNC5o3H4lBEi","createdTime":"2021-01-01T00:00:00.000Z","filter":"appLkNDICXNqxSDhG","id":"ealLvFqm3oJNxg30m","state":"processing","timePeriod":"2021-01"}}},"schema":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FAudit-log"}}},"description":"Placeholder Description"}},"security":[{"oauth":["enterprise.auditLogs:read"]}],"summary":"Get audit log request","tags":["auditing"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"]},"parameters":[{"in":"path","name":"enterpriseAccountId","required":true,"schema":{"pattern":"ent[0-9a-zA-Z]{14}$","type":"string"}},{"in":"path","name":"enterpriseAuditLogTaskId","required":true,"schema":{"pattern":"eal[0-9a-zA-Z]{14}$","type":"string"}}]},"\u002Fv0\u002Fmeta\u002FenterpriseAccounts\u002F{enterpriseAccountId}\u002FchangeEvents":{"get":{"description":"Retrieve change events for enterprise bases. These change events are available for 14 days from the date of the event.\n\nThis endpoint requires change events to be enabled for your enterprise account and toggled on in your enterprise admin panel. Please contact your account team or support to start this process. Events are generated only after you turn change events on in your admin panel.","operationId":"change-events","parameters":[{"in":"query","name":"startTime","schema":{"description":"Earliest change event to retrieve (inclusive), in ISO 8601 date time format. Optional.","type":"string"}},{"in":"query","name":"endTime","schema":{"description":"Latest change event to retrieve (exclusive), in ISO 8601 date time format. Optional.","type":"string"}},{"in":"query","name":"pageSize","schema":{"description":"The number of records per page. Maximum value of 100; defaults to 10.","type":"number"}},{"in":"query","name":"offset","schema":{"description":"If there may be more to retrieve, an **offset** is returned.\nPass the **offset** to the next call to retrieve the next page. Do not pass **offset** when retrieving the first page.","type":"string"}}],"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Success Response","summary":"Success response","value":{"events":[{"actor":{"type":"user","user":{"email":"foo@bar.com","id":"usrL2PNC5o3H4lBEi","name":"Jane Doe"}},"context":{"baseId":"appLkNDICXNqxSDhG"},"eventTimestamp":"2022-02-01T21:25:05.663Z","id":"01FYFFDE39BDDBC0HWK51R6GPF","objectId":"appLkNDICXNqxSDhG","objectType":"base","origin":{"ipAddress":"1.2.3.4"},"payload":{"data":{"changedTablesById":{"tbltp8DGLhqbUmjK1":{"changedFieldsById":{"fldoi0c3GaRQJ3xnI":{"current":{"name":"new name"},"previous":{"name":"previous name"}}},"changedMetadata":{"current":{"description":"table description","name":"table name"},"previous":{"description":"previous name","name":"previous name"}},"changedRecordsById":{"rec560UJdUtocSouk":{"current":{"cellValuesByFieldId":{"fldgdCnvrkNsrWnDn":[{"id":"rec560UJdUtocSouk","name":"Record primary column value"}],"fldoi0c3GaRQJ3xnI":"Updated hello world"}},"previous":{"cellValuesByFieldId":{"fldgdCnvrkNsrWnDn":null,"fldoi0c3GaRQJ3xnI":"Hello world"}}}},"changedRecordsMetadataById":{"rec560UJdUtocSouk":{"changedCommentsById":{"comB5z37Mg9zaEPw6":{"current":{"text":"updated comment text"},"previous":{"text":"previous comment text"}}},"createdCommentsById":{"comB5z37Mg9zaEPw6":{"text":"comment text"}},"destroyedCommentIds":["comB5z37Mg9zaEPw6"]}},"createdFieldsById":{"fldoi0c3GaRQJ3xnI":{"name":"new name","type":"number"}},"createdRecordsById":{"rec560UJdUtocSouk":{"cellValuesByFieldId":{"fldoi0c3GaRQJ3xnI":"Hello world"},"createdTime":"2022-02-01T21:25:05.663Z"}},"destroyedFieldIds":["fldoi0c3GaRQJ3xnI"]}},"createdTablesById":{"tbltp8DGLhqbUmjK1":{"fieldsById":{"fldoi0c3GaRQJ3xnI":{"name":"Name","type":"singleLineText"}},"metadata":{"description":"new table description","name":"new table"},"recordsById":{"rec560UJdUtocSouk":{"cellValuesByFieldId":{"fldoi0c3GaRQJ3xnI":"Hello world"},"createdTime":"2022-02-01T21:25:05.663Z"}},"recordsMetadataById":{"rec560UJdUtocSouk":{"commentsById":{"comB5z37Mg9zaEPw6":{"text":"comment text"}}}}}},"destroyedTableIds":["tbltp8DGLhqbUmjK1"]},"version":"v0"},"timestamp":"2022-02-01T21:25:05.663Z","type":"base_modified"}],"offset":"01FYET2W5BGQ24DXT5C4AG36PR"}}},"schema":{"properties":{"events":{"description":"Events are returned newest to oldest.","items":{"properties":{"actor":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FChange-events-actor","description":"The actor that caused the change event. Note that this could be a user or an internal system."},"context":{"description":"Additional context about the change event.","properties":{"actionId":{"type":"string"},"applicationId":{"description":"Deprecated. Use `baseId` instead.","type":"string"},"baseId":{"description":"Base ID, a unique identifier for a base.","type":"string"}},"required":["baseId"],"type":"object"},"eventTimestamp":{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},"id":{"type":"string"},"objectId":{"description":"ID of the affected object.","type":"string"},"objectType":{"const":"base","description":"Type of the affected object. Currently only 'base'.","type":"string"},"origin":{"description":"Contains additional information about the request origin, including IP address.","properties":{"ipAddress":{"type":"string"}},"required":["ipAddress"],"type":"object"},"payload":{"description":"Payload of base changes. This captures changes to base's schema, cell values, attachment URLs, and record comments.\n\nEach **created\\***, **destroyed\\***, **changed\\*** field is optional.\n\nRefer to [field types](\u002Fapi\u002Ffield-model) for more information about cell value payloads.","properties":{"data":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FChange-events-data"},"version":{"const":"v0","type":"string"}},"required":["version","data"],"type":"object"},"timestamp":{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},"type":{"description":"The type of event. **base_modified** is currently the only value.","type":"string"}},"required":["id","timestamp","eventTimestamp","actor","origin","type","context","objectId","objectType","payload"],"type":"object"},"type":"array"},"offset":{"description":"Pagination token. Pass this value as the **offset** query parameter to retrieve the next page.","type":"string"}},"required":["events"],"type":"object"}}},"description":"Placeholder Description"},"422":{"content":{"application\u002Fjson":{"examples":{"Invalid offset":{"description":"Invalid **offset**. See error message for exact reason.","summary":"Invalid offset","value":{"error":{"message":"Offset token is invalid for this query","type":"INVALID_OFFSET_VALUE"}}},"Invalid pageSize":{"description":"Invalid **pageSize**. See error message for exact reason.","summary":"Invalid pageSize","value":{"error":{"message":"Maximum pageSize is 100","type":"INVALID_PAGE_SIZE_ARGUMENT"}}},"Invalid time":{"description":"Invalid **startTime** or **endTime**. See error message for exact reason.","summary":"Invalid time","value":{"error":{"message":"startTime cannot be same or after endTime","type":"INVALID_TIME_RANGE"}}}}}},"description":"Placeholder Description"}},"security":[{"oauth":["enterprise.changeEvents:read"]}],"summary":"Change events","tags":["changeEvents"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"],"x-airtable-override-documentation-billing-plan":["enterpriseScale"]},"parameters":[{"in":"path","name":"enterpriseAccountId","required":true,"schema":{"pattern":"ent[0-9a-zA-Z]{14}$","type":"string"}}]},"\u002Fv0\u002Fmeta\u002FenterpriseAccounts\u002F{enterpriseAccountId}\u002Fdescendants":{"parameters":[{"in":"path","name":"enterpriseAccountId","required":true,"schema":{"pattern":"ent[0-9a-zA-Z]{14}$","type":"string"}}],"post":{"description":"Creates a descendant enterprise account of the enterprise account.\nDescendant enterprise accounts can only be created for root enterprise accounts with the Enterprise Hub feature enabled.\n\nNote that descendant enterprise accounts are also called organizational units (org units).\n\nFor more information on org units in organizations with Enterprise Hub, please see [our support article](https:\u002F\u002Fsupport.airtable.com\u002Fdocs\u002Fenterprise-hub-in-airtable#understanding-and-using-organizational-units).","operationId":"create-descendant-enterprise","requestBody":{"content":{"application\u002Fjson":{"examples":{"Success Response":{"description":"Success Response","summary":"Success Response","value":{"name":"Example name"}}},"schema":{"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"}}}},"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success Response":{"description":"Success Response","summary":"Success Response","value":{"id":"entUBq2RGdihxl3vU"}}},"schema":{"properties":{"id":{"type":"string"}},"required":["id"],"type":"object"}}},"description":"Placeholder Description"}},"security":[{"oauth":["enterprise.account:write"]}],"summary":"Create descendant enterprise","tags":["enterprise"],"x-airtable-auth-methods":["personalAccessToken","oauthAccessToken"]}},"\u002Fv0\u002Fmeta\u002FenterpriseAccounts\u002F{enterpriseAccountId}\u002Fexports":{"get":{"description":"Get the status and result of all eDiscovery exports.","operationId":"list-ediscovery-export","parameters":[{"examples":{"Success Response":{"description":"Success Response","summary":"Success Response","value":"done"}},"in":"query","name":"state","schema":{"description":"Filter for exports with the specified state.","enum":["pending","processing","error","done"],"type":"string"}},{"in":"query","name":"pageSize","schema":{"description":"The number of records per page. Maximum value of 100; defaults to 10.","type":"number"}},{"in":"query","name":"offset","schema":{"description":"If there may be more to retrieve, an **offset** is returned.\nPass the **offset** to the next call to retrieve the next page. Do not pass **offset** when retrieving the first page.","type":"number"}}],"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success Response":{"description":"Success Response","summary":"Success Response","value":{"exports":[{"createdTime":"2021-01-01T00:00:00.000Z","data":{"csvZipDownloadUrl":"https:\u002F\u002Fexample.com\u002Fediscovery_export.zip","expirationTime":"2021-01-30T00:00:00.000Z","jsonDownloadUrl":"https:\u002F\u002Fexample.com\u002Fediscovery_export.json"},"id":"etkJkReGfIaW8DZq5","request":{"baseId":"appLkNDICXNqxSDhG","includeCsvFormat":true,"shouldSendEmailOnCompletion":true},"state":"done","user":{"email":"foo@bar.com","id":"usrL2PNC5o3H4lBEi","name":"Barry Allen"}}],"offset":10}}},"schema":{"properties":{"exports":{"description":"eDiscovery exports are returned newest to oldest.","items":{"properties":{"createdTime":{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},"data":{"description":"Available once the export completes.","properties":{"csvZipDownloadUrl":{"description":"URL to download CSV export (as a zipped file), if `includeCsvFormat` was\nset for this export.","type":"string"},"expirationTime":{"description":"The date and time at which the download URLs expire.","type":"string"},"jsonDownloadUrl":{"description":"URL to download JSON export.","type":"string"}},"required":["jsonDownloadUrl","expirationTime"],"type":"object"},"error":{"description":"If state is `error`, this will contain an error message.","type":"string"},"id":{"type":"string"},"request":{"properties":{"baseId":{"description":"Base ID of the export.","type":"string"},"includeCsvFormat":{"description":"Whether the export includes a CSV export (as a zipped file).","type":"boolean"},"shouldSendEmailOnCompletion":{"description":"Whether an email notification should be sent when the export is complete.","type":"boolean"}},"required":["baseId","includeCsvFormat","shouldSendEmailOnCompletion"],"type":"object"},"state":{"enum":["pending","processing","error","done"],"type":"string"},"user":{"description":"The user that created the eDiscovery export.","properties":{"email":{"type":"string"},"id":{"description":"A user ID","type":"string"},"name":{"type":"string"}},"required":["id","email","name"],"type":"object"}},"required":["id","createdTime","user","request","state"],"type":"object"},"type":"array"},"offset":{"description":"Offset pagination token to pass in to get the next page of results.","type":"number"}},"required":["exports"],"type":"object"}}},"description":"Placeholder Description"}},"security":[{"oauth":["enterprise.exports:manage"]}],"summary":"List eDiscovery exports","tags":["changeEvents"],"x-airtable-auth-methods":["personalAccessToken","oauthAccessToken"],"x-airtable-override-documentation-billing-plan":["enterpriseScale"]},"parameters":[{"in":"path","name":"enterpriseAccountId","required":true,"schema":{"pattern":"ent[0-9a-zA-Z]{14}$","type":"string"}}],"post":{"description":"Create an eDiscovery export request.\nThe response includes an `id`, which is then used to [check the status of and download](\u002Fapi\u002Fget-ediscovery-export) your export.","operationId":"create-ediscovery-export","requestBody":{"content":{"application\u002Fjson":{"examples":{"Error Response":{"description":"Invalid base ID","summary":"Error Response","value":{"baseId":"appLkNDICXNqxSDhG"}},"Success Response":{"description":"Success Response","summary":"Success Response","value":{"baseId":"appLkNDICXNqxSDhG","includeCsvFormat":true,"shouldSendEmailOnCompletion":true}}},"schema":{"properties":{"baseId":{"description":"Base ID to create eDiscovery export for.","type":"string"},"includeCsvFormat":{"description":"If set, also export the base as CSVs (in a zipped file). Once the export is\nready for download, the URL to the zip file will be available in the `csvZipDownloadUrl` attribute.","type":"boolean"},"shouldSendEmailOnCompletion":{"description":"If set, an email will be sent to the user who initiated the export once the\nexport is ready for download.","type":"boolean"}},"required":["baseId"],"type":"object"}}}},"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success Response":{"description":"Success Response","summary":"Success Response","value":{"createdTime":"2021-01-01T00:00:00.000Z","id":"etkJkReGfIaW8DZq5","request":{"baseId":"appLkNDICXNqxSDhG","includeCsvFormat":true,"shouldSendEmailOnCompletion":true},"state":"processing","user":{"email":"foo@bar.com","id":"usrL2PNC5o3H4lBEi","name":"Barry Allen"}}}},"schema":{"properties":{"createdTime":{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},"data":{"description":"Available once the export completes.","properties":{"csvZipDownloadUrl":{"description":"URL to download CSV export (as a zipped file), if `includeCsvFormat` was\nset for this export.","type":"string"},"expirationTime":{"description":"The date and time at which the download URLs expire.","type":"string"},"jsonDownloadUrl":{"description":"URL to download JSON export.","type":"string"}},"required":["jsonDownloadUrl","expirationTime"],"type":"object"},"error":{"description":"If state is `error`, this will contain an error message.","type":"string"},"id":{"type":"string"},"request":{"properties":{"baseId":{"description":"Base ID of the export.","type":"string"},"includeCsvFormat":{"description":"Whether the export includes a CSV export (as a zipped file).","type":"boolean"},"shouldSendEmailOnCompletion":{"description":"Whether an email notification should be sent when the export is complete.","type":"boolean"}},"required":["baseId","includeCsvFormat","shouldSendEmailOnCompletion"],"type":"object"},"state":{"enum":["pending","processing","error","done"],"type":"string"},"user":{"description":"The user that created the eDiscovery export.","properties":{"email":{"type":"string"},"id":{"description":"A user ID","type":"string"},"name":{"type":"string"}},"required":["id","email","name"],"type":"object"}},"required":["id","createdTime","user","request","state"],"type":"object"}}},"description":"Placeholder Description"},"404":{"content":{"application\u002Fjson":{"examples":{"Error Response":{"description":"Invalid base ID","summary":"Error Response","value":{"error":{"type":"NOT_FOUND"}}}}}},"description":"Placeholder Description"}},"security":[{"oauth":["enterprise.exports:manage"]}],"summary":"Create eDiscovery export","tags":["changeEvents"],"x-airtable-auth-methods":["personalAccessToken","oauthAccessToken"],"x-airtable-override-documentation-billing-plan":["enterpriseScale"]}},"\u002Fv0\u002Fmeta\u002FenterpriseAccounts\u002F{enterpriseAccountId}\u002Fexports\u002F{enterpriseTaskId}":{"get":{"description":"Get the status and result of an eDiscovery export.","operationId":"get-ediscovery-export","parameters":[],"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success Response":{"description":"Success Response","summary":"Success Response","value":{"createdTime":"2021-01-01T00:00:00.000Z","data":{"csvZipDownloadUrl":"https:\u002F\u002Fexample.com\u002Fediscovery_export.zip","expirationTime":"2021-01-30T00:00:00.000Z","jsonDownloadUrl":"https:\u002F\u002Fexample.com\u002Fediscovery_export.json"},"id":"etkJkReGfIaW8DZq5","request":{"baseId":"appLkNDICXNqxSDhG","includeCsvFormat":true,"shouldSendEmailOnCompletion":true},"state":"done","user":{"email":"foo@bar.com","id":"usrL2PNC5o3H4lBEi","name":"Barry Allen"}}}},"schema":{"properties":{"createdTime":{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},"data":{"description":"Available once the export completes.","properties":{"csvZipDownloadUrl":{"description":"URL to download CSV export (as a zipped file), if `includeCsvFormat` was\nset for this export.","type":"string"},"expirationTime":{"description":"The date and time at which the download URLs expire.","type":"string"},"jsonDownloadUrl":{"description":"URL to download JSON export.","type":"string"}},"required":["jsonDownloadUrl","expirationTime"],"type":"object"},"error":{"description":"If state is `error`, this will contain an error message.","type":"string"},"id":{"type":"string"},"request":{"properties":{"baseId":{"description":"Base ID of the export.","type":"string"},"includeCsvFormat":{"description":"Whether the export includes a CSV export (as a zipped file).","type":"boolean"},"shouldSendEmailOnCompletion":{"description":"Whether an email notification should be sent when the export is complete.","type":"boolean"}},"required":["baseId","includeCsvFormat","shouldSendEmailOnCompletion"],"type":"object"},"state":{"enum":["pending","processing","error","done"],"type":"string"},"user":{"description":"The user that created the eDiscovery export.","properties":{"email":{"type":"string"},"id":{"description":"A user ID","type":"string"},"name":{"type":"string"}},"required":["id","email","name"],"type":"object"}},"required":["id","createdTime","user","request","state"],"type":"object"}}},"description":"Placeholder Description"},"404":{"content":{"application\u002Fjson":{"examples":{"Error Response":{"description":"Invalid task ID","summary":"Error Response","value":{"error":{"type":"NOT_FOUND"}}}}}},"description":"Placeholder Description"}},"security":[{"oauth":["enterprise.exports:manage"]}],"summary":"Get eDiscovery export","tags":["changeEvents"],"x-airtable-auth-methods":["personalAccessToken","oauthAccessToken"],"x-airtable-override-documentation-billing-plan":["enterpriseScale"]},"parameters":[{"in":"path","name":"enterpriseAccountId","required":true,"schema":{"pattern":"ent[0-9a-zA-Z]{14}$","type":"string"}},{"in":"path","name":"enterpriseTaskId","required":true,"schema":{"pattern":"etk[0-9a-zA-Z]{14}$","type":"string"}}]},"\u002Fv0\u002Fmeta\u002FenterpriseAccounts\u002F{enterpriseAccountId}\u002FmoveGroups":{"parameters":[{"in":"path","name":"enterpriseAccountId","required":true,"schema":{"pattern":"ent[0-9a-zA-Z]{14}$","type":"string"}}],"post":{"description":"Batch move user groups between two enterprise accounts belonging to the same organization.\n\nThis endpoint can only be used if your enterprise account has the Enterprise Hub feature enabled.\n\nIf the target enterprise account has the invites settings restricted to org unit members, group members who are non-org\nunit members will be removed when the user groups are moved.\n\nFor more information about invites settings, please see [our support article](https:\u002F\u002Fsupport.airtable.com\u002Fdocs\u002Fsettings-airtable-admin-panel#sharing-and-data-in-the-admin-panel).","operationId":"move-user-groups","requestBody":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Success Response","summary":"Success response","value":{"groupIds":["ugp1mKGb3KXUyQfOZ","ugp1mKGb3KXUyQfOZ","ugpR8ZT9KtIgp8Bh3","ugp1UdbspZKMrIOjk"],"targetEnterpriseAccountId":"entUBq2RGdihxl3vU"}}},"schema":{"properties":{"groupIds":{"description":"ID of the groups to be moved. Up to 100 groupIds can be provided.","items":{"description":"A user group ID","type":"string"},"type":"array"},"targetEnterpriseAccountId":{"description":"ID of the target enterprise account of the move. The target enterprise account must be in the same Hub-enabled\norganization as the source enterprise account, and you must have admin rights over the target enterprise account.","type":"string"}},"required":["groupIds","targetEnterpriseAccountId"],"type":"object"}}}},"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Success Response","summary":"Success response","value":{"errors":[{"id":"ugp1mKGb3KXUyQfOZ","message":"Duplicate group","type":"DUPLICATE"},{"id":"ugpR8ZT9KtIgp8Bh3","message":"Group not found","type":"NOT_FOUND"},{"id":"ugp1UdbspZKMrIOjk","message":"Group is not managed by the enterprise account","type":"INVALID_PERMISSIONS"}],"movedGroups":[{"id":"ugp1mKGb3KXUyQfOZ"}]}}},"schema":{"properties":{"errors":{"items":{"properties":{"id":{"description":"A user group ID","type":"string"},"message":{"type":"string"},"type":{"type":"string"}},"required":["id","type","message"],"type":"object"},"type":"array"},"movedGroups":{"items":{"properties":{"id":{"description":"A user group ID","type":"string"},"removedUserIds":{"description":"A list of group members removed from the group as part of the move.\nOnly returned when the target enterprise account has the invites settings restricted to org unit members.","items":{"description":"A user ID","type":"string"},"type":"array"}},"required":["id"],"type":"object"},"type":"array"}},"required":["errors","movedGroups"],"type":"object"}}},"description":"Placeholder Description"}},"security":[{"oauth":["enterprise.groups:manage"]}],"summary":"Move user groups","tags":["userManagement"],"x-airtable-auth-methods":["personalAccessToken","oauthAccessToken"]}},"\u002Fv0\u002Fmeta\u002FenterpriseAccounts\u002F{enterpriseAccountId}\u002FmoveWorkspaces":{"parameters":[{"in":"path","name":"enterpriseAccountId","required":true,"schema":{"pattern":"ent[0-9a-zA-Z]{14}$","type":"string"}}],"post":{"description":"Batch move workspaces between two enterprise accounts belonging to the same organization.\n\nThis endpoint can only be used if your enterprise account has the Enterprise Hub feature enabled.\n\nIf the target enterprise account has the invite settings restricted to org unit members, all non-org unit member\ncollaborators will be removed when the workspaces are moved.\n\nFor more information about invites settings, please see [our support article](https:\u002F\u002Fsupport.airtable.com\u002Fdocs\u002Fsettings-airtable-admin-panel#sharing-and-data-in-the-admin-panel).","operationId":"move-workspaces","requestBody":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Success Response","summary":"Success response","value":{"targetEnterpriseAccountId":"entUBq2RGdihxl3vU","workspaceIds":["wspmhESAta6clCCwF","wspHvvm4dAktsStZH","wspHvvm4dAktsStZH","wspgAeR3b03M3tSSy","wsp4mAKZgXB0vBqU2"]}}},"schema":{"properties":{"replacementOwnerId":{"description":"If the target enterprise account has the invites settings restricted to org unit members, all non-member\ncollaborators will be removed when the workspace are moved. If any workspace only has non-member owners, you must specify\na replacementOwnerId to be added as the new owner of such workspaces. If no workspace has only non-member owners, replaceOwnerId\nis optional and will be ignored if provided.","type":"string"},"targetEnterpriseAccountId":{"description":"ID of the target enterprise account of the move. The target enterprise account must be in the same Hub-enabled\norganization as the source enterprise account, and you must have admin rights over the target enterprise account.","type":"string"},"workspaceIds":{"description":"ID of the workspaces to be moved. Up to 100 workspaceIds can be provided.","items":{"type":"string"},"type":"array"}},"required":["workspaceIds","targetEnterpriseAccountId"],"type":"object"}}}},"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Success Response","summary":"Success response","value":{"errors":[{"id":"wspmhESAta6clCCwF","message":"Workspace not found","type":"NOT_FOUND"},{"id":"wspHvvm4dAktsStZH","message":"Duplicate workspace","type":"DUPLICATE"},{"id":"wsp4mAKZgXB0vBqU2","message":"Workspace is not managed by the enterprise account","type":"INVALID_PERMISSIONS"}],"movedWorkspaces":[{"id":"wspHvvm4dAktsStZH"},{"id":"wspgAeR3b03M3tSSy"}]}}},"schema":{"properties":{"errors":{"items":{"properties":{"id":{"type":"string"},"message":{"type":"string"},"type":{"type":"string"}},"required":["id","type","message"],"type":"object"},"type":"array"},"movedWorkspaces":{"items":{"properties":{"id":{"type":"string"}},"required":["id"],"type":"object"},"type":"array"}},"required":["errors","movedWorkspaces"],"type":"object"}}},"description":"Placeholder Description"}},"security":[{"oauth":["workspacesAndBases:manage"]}],"summary":"Move workspaces","tags":["workspace"],"x-airtable-auth-methods":["personalAccessToken","oauthAccessToken"]}},"\u002Fv0\u002Fmeta\u002FenterpriseAccounts\u002F{enterpriseAccountId}\u002Fusers":{"delete":{"description":"Delete multiple users by email.","operationId":"delete-users-by-email","parameters":[{"examples":{"Success Response":{"description":"Success Response","summary":"Success Response","value":["foo@bar.com","bar@bam.com"]}},"in":"query","name":"email","schema":{"items":{"type":"string"},"type":"array","x-airtable-query-parameter-name":"email"}}],"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success Response":{"description":"Success Response","summary":"Success Response","value":{"deletedUsers":[{"email":"foo@bar.com","id":"usrL2PNC5o3H4lBEi"}],"errors":[{"email":"bar@bam.com","message":"Invalid permissions","type":"INVALID_PERMISSIONS"}]}}},"schema":{"properties":{"deletedUsers":{"items":{"properties":{"email":{"type":"string"},"id":{"description":"A user ID","type":"string"}},"required":["id","email"],"type":"object"},"type":"array"},"errors":{"items":{"properties":{"email":{"type":"string"},"message":{"type":"string"},"type":{"type":"string"}},"required":["email","type"],"type":"object"},"type":"array"}},"required":["deletedUsers","errors"],"type":"object"}}},"description":"Placeholder Description"},"403":{"content":{"application\u002Fjson":{"examples":{"Action on self failure":{"description":"Don't deactivate yourself or you might lose access. If action must be performed, add another admin.","summary":"Action on self failure","value":{"error":{"message":"Cannot perform action on self","type":"INVALID_PERMISSIONS"}}},"Cannot delete sole owner":{"description":"If a workspace has more than one collaborator, it must have at least one owner. So the sole owner cannot be deleted.","summary":"Cannot delete sole owner","value":{"error":{"message":"Cannot delete sole owner of a workspace with other collaborators","type":"INVALID_PERMISSIONS"}}},"External user account":{"description":"Cannot modify external user state since they are not considered part of the enterprise account.","summary":"External user account","value":{"error":{"message":"User does not belong to the enterprise email domain","type":"INVALID_PERMISSIONS"}}},"FLA account error":{"description":"The provisioned and deactivated states apply only to ELA and \"claiming\" enterprise accounts. FLA users are always provisioned.","summary":"FLA account error","value":{"error":{"message":"State modification is not enabled for FLA enterprise accounts","type":"INVALID_PERMISSIONS"}}},"Non-managed user account":{"description":"Can only manage information of managed users.","summary":"Non-managed user account","value":{"error":{"message":"User is not managed by the enterprise account","type":"INVALID_PERMISSIONS"}}}}}},"description":"Placeholder Description"}},"security":[{"oauth":["enterprise.user:write"]}],"summary":"Delete users by email","tags":["user"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"]},"get":{"description":"Returns basic information relevant to both [internal](\u002Fapi\u002Forg-management-glossary#internal-user) and [external](\u002Fapi\u002Forg-management-glossary#external-user) user.","operationId":"get-users-by-id-or-email","parameters":[{"examples":{"Example response":{"description":"Simple example","summary":"Example response","value":["foo@bar.com"]}},"in":"query","name":"email","schema":{"description":"Email addresses to search by. If the request does not have any userIds, you must include at least one email address.","items":{"type":"string"},"type":"array","x-airtable-query-parameter-name":"email"}},{"examples":{"Example response":{"description":"Simple example","summary":"Example response","value":["usrsOEchC9xuwRgKk"]}},"in":"query","name":"id","schema":{"description":"User Ids to search by. If the request does not have any email addresses, you must include at least one userId.","items":{"description":"A user ID","type":"string"},"type":"array","x-airtable-query-parameter-name":"id"}},{"examples":{"Example response":{"description":"Simple example","summary":"Example response","value":["collaborations"]}},"in":"query","name":"include","schema":{"description":"Allows optionally including collaborations in response.","items":{"enum":["collaborations","aggregated","descendants"],"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Example response":{"description":"Simple example","summary":"Example response","value":{"users":[{"collaborations":{"baseCollaborations":[{"baseId":"appLkNDICXNqxSDhG","createdTime":"2019-01-03T12:33:12.421Z","grantedByUserId":"usrqccqnMB2eHylqB","permissionLevel":"edit"}],"interfaceCollaborations":[],"workspaceCollaborations":[]},"createdTime":"2019-01-03T12:33:12.421Z","email":"baz@bar.com","groups":[{"id":"ugpR8ZT9KtIgp8Bh3"}],"id":"usrsOEchC9xuwRgKk","invitedToAirtableByUserId":"usrGcrteE5fUMqq0R","isAdmin":false,"isManaged":true,"isServiceAccount":false,"isSsoRequired":true,"isTwoFactorAuthEnabled":false,"lastActivityTime":"2019-01-03T12:33:12.421Z","name":"baz bar","state":"provisioned"},{"collaborations":{"baseCollaborations":[{"baseId":"appLkNDICXNqxSDhG","createdTime":"2019-01-03T12:33:12.421Z","grantedByUserId":"usrqccqnMB2eHylqB","permissionLevel":"edit"}],"interfaceCollaborations":[{"baseId":"appLkNDICXNqxSDhG","createdTime":"2019-01-03T12:33:12.421Z","grantedByUserId":"usrogvSbotRtzdtZW","interfaceId":"pbdyGA3PsOziEHPDE","permissionLevel":"edit"}],"workspaceCollaborations":[{"createdTime":"2019-01-03T12:33:12.421Z","grantedByUserId":"usrGcrteE5fUMqq0R","permissionLevel":"owner","workspaceId":"wspmhESAta6clCCwF"}]},"createdTime":"2019-01-03T12:33:12.421Z","email":"foo@bar.com","groups":[{"id":"ugp1mKGb3KXUyQfOZ"},{"id":"ugpR8ZT9KtIgp8Bh3"}],"id":"usrL2PNC5o3H4lBEi","invitedToAirtableByUserId":"usrsOEchC9xuwRgKk","isAdmin":true,"isManaged":true,"isServiceAccount":false,"isSsoRequired":true,"isTwoFactorAuthEnabled":false,"lastActivityTime":"2019-01-03T12:33:12.421Z","name":"foo baz","state":"provisioned"}]}}},"schema":{"properties":{"users":{"items":{"properties":{"aggregated":{"description":"The user's aggregated values across this enterprise account and its descendants.\nOnly returned when the user is on a claimed domain and the enterprise account has the Enterprise Hub feature enabled.","properties":{"collaborations":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FCollaborations","description":"The user's direct collaborations on workspaces, bases and interfaces associated with this enterprise account and its descendants.\nExcludes collaborations from groups."},"groups":{"description":"This field specifies the groups associated with this enterprise account and its descendants that the user belongs to.","items":{"properties":{"id":{"description":"A user group ID","type":"string"}},"required":["id"],"type":"object"},"type":"array"},"isAdmin":{"description":"Whether the user has directly assigned admin rights over this enterprise account or its descendants.","type":"boolean"},"lastActivityTime":{"anyOf":[{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},{"type":"null"}],"description":"Most recent time the user interacted with this enterprise account and its descendants' data. null if never."}},"required":["lastActivityTime"],"type":"object"},"collaborations":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FCollaborations","description":"The user's direct collaborations on workspaces, bases and interfaces associated with this enterprise account.\nExcludes collaborations from groups."},"createdTime":{"description":"When user was created. This field is only returned when user is internal.","type":"string"},"descendants":{"additionalProperties":{"properties":{"collaborations":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FCollaborations"},"groups":{"items":{"properties":{"id":{"description":"A user group ID","type":"string"}},"required":["id"],"type":"object"},"type":"array"},"isAdmin":{"type":"boolean"},"isManaged":{"type":"boolean"},"lastActivityTime":{"anyOf":[{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},{"type":"null"}]}},"required":["lastActivityTime"],"type":"object"},"description":"The user's values per descendant enterprise account.\nOnly returned when the user is on a claimed domain and the enterprise account has the Enterprise Hub feature enabled.","type":"object"},"email":{"type":"string"},"enterpriseUserType":{"description":"The type of user. Only returned if the enterprise has group mappings active and only if user is internal.","enum":["accessReadOnlyShareLinks","full"],"type":"string"},"groups":{"description":"This field specifies the groups associated with this enterprise account that the user belongs to.\nThis field is only returned when the user is internal.","items":{"properties":{"id":{"description":"A user group ID","type":"string"}},"required":["id"],"type":"object"},"type":"array"},"id":{"description":"A user ID","type":"string"},"invitedToAirtableByUserId":{"anyOf":[{"description":"A user ID","type":"string"},{"type":"null"}],"description":"This field is only returned when either the inviter or the user is internal.\nIf there is no inviter, this field is null.\nIf user is internal but inviter is external, this field is \"usrEXTERNREDACTED\"."},"isAdmin":{"description":"Whether the user has directly assigned admin rights over this enterprise account. Only returned when\nthe user is on a claimed domain.\nNote: if a user is a super admin but is not directly assigned admin rights over this enterprise account, this field is `false`.","type":"boolean"},"isManaged":{"description":"Whether the user is managed by this enterprise account. Only returned when the user is on a claimed domain.","type":"boolean"},"isServiceAccount":{"description":"Whether the user is a [service account](https:\u002F\u002Fsupport.airtable.com\u002Fdocs\u002Fen\u002Fservice-accounts-overview).","type":"boolean"},"isSsoRequired":{"description":"Whether the user is required to authenticate through their administrating enterprise's identity provider to login.\nFalse if user is not on an enterprise.","type":"boolean"},"isSuperAdmin":{"description":"Whether the user has super admin rights over this enterprise account. Only returned when the user is on a claimed\ndomain and the enterprise account has the Enterprise Hub feature enabled.","type":"boolean"},"isTwoFactorAuthEnabled":{"description":"Whether the user configured a second authentication method when logging in to Airtable through username\u002Fpassword auth.","type":"boolean"},"lastActivityTime":{"anyOf":[{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},{"type":"null"}],"description":"Most recent time the user interacted with this enterprise account's data. null if never."},"name":{"type":"string"},"state":{"description":"[provisioned](\u002Fapi\u002Forg-management-glossary#provisioned-user) | [deactivated](\u002Fapi\u002Forg-management-glossary#deactivated-user)","enum":["provisioned","deactivated"],"type":"string"}},"required":["id","state","email","name","lastActivityTime","isTwoFactorAuthEnabled","isSsoRequired","isServiceAccount"],"type":"object"},"type":"array"}},"required":["users"],"type":"object"}}},"description":"Placeholder Description"}},"security":[{"oauth":["enterprise.user:read"]}],"summary":"Get users by id or email","tags":["user"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"]},"parameters":[{"in":"path","name":"enterpriseAccountId","required":true,"schema":{"pattern":"ent[0-9a-zA-Z]{14}$","type":"string"}}],"patch":{"description":"Batch manage enterprise account users.\nOne of `id` or `email` must supplied in the body. If both are supplied, `id` will be used as the identifier in changing user email to the `email` specified in the request.\n\n*WARNING:* We recommend performing actions on up to 10 users at a time to avoid timeouts. Though we currently do not enforce a limit on the number of users you can manage at once, we are monitoring the performance of this endpoint and may enforce a limit in the future.","operationId":"manage-user-batched","requestBody":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Success Response","summary":"Success response","value":{"users":[{"email":"foo@bar.com","id":"usrL2PNC5o3H4lBEi","state":"provisioned"},{"id":"usrsOEchC9xuwRgKk","state":"deactivated"},{"email":"foo@bam.com","id":"usrL2PNC5o3H4lBEi"},{"email":"bam@bam.com","state":"provisioned"}]}}},"schema":{"properties":{"users":{"items":{"properties":{"email":{"description":"Enterprise account must own both the original and destination email domains.\n\n*WARNING:* If SSO is required for your enterprise account, you must follow these steps precisely to\navoid locking the end user out of their account or creating duplicate accounts.\n\n - Use this API to update the user's email to a new value (this effectively logs the user out)\n - Use your SSO provider's (e.g. Okta's) admin panel to update the user's email to the new value\n - Tell the user to log into Airtable with the new email","type":"string"},"firstName":{"type":"string"},"id":{"description":"A user ID","type":"string"},"lastName":{"type":"string"},"state":{"description":"[provisioned](\u002Fapi\u002Forg-management-glossary#provisioned-user) | [deactivated](\u002Fapi\u002Forg-management-glossary#deactivated-user)\nCan only change the state of [managed](\u002Fapi\u002Forg-management-glossary#managed-user) users.","enum":["provisioned","deactivated"],"type":"string"}},"type":"object"},"type":"array"}},"required":["users"],"type":"object"}}}},"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Success Response","summary":"Success response","value":{"errors":[{"id":"usrqccqnMB2eHylqB","message":"User not found","type":"MODEL_ID_NOT_FOUND"},{"email":"foo@bam.com","message":"Email not found","type":"NOT_FOUND"}],"updatedUsers":[{"email":"foo@bar.com","id":"usrGcrteE5fUMqq0R","state":"provisioned"},{"id":"usrsOEchC9xuwRgKk","state":"deactivated"}]}}},"schema":{"properties":{"errors":{"items":{"properties":{"email":{"type":"string"},"id":{"description":"A user ID","type":"string"},"message":{"type":"string"},"type":{"type":"string"}},"required":["type","message"],"type":"object"},"type":"array"},"updatedUsers":{"items":{"properties":{"email":{"description":"Only returned if it is provided in the request body.","type":"string"},"firstName":{"type":"string"},"id":{"description":"A user ID","type":"string"},"lastName":{"type":"string"},"state":{"description":"Only returned if it is provided in the request body.","enum":["provisioned","deactivated"],"type":"string"}},"required":["id"],"type":"object"},"type":"array"}},"required":["errors","updatedUsers"],"type":"object"}}},"description":"Placeholder Description"},"403":{"content":{"application\u002Fjson":{"examples":{"Action on self failure":{"description":"Don't deactivate yourself or you might lose access. If action must be performed, add another admin.","summary":"Action on self failure","value":{"error":{"message":"Cannot perform action on self","type":"INVALID_PERMISSIONS"}}},"External user account":{"description":"Cannot modify external user state since they are not considered part of the enterprise account.","summary":"External user account","value":{"error":{"message":"User does not belong to the enterprise email domain","type":"INVALID_PERMISSIONS"}}},"FLA account error":{"description":"The provisioned and deactivated states apply only to ELA and \"claiming\" enterprise accounts. FLA users are always provisioned.","summary":"FLA account error","value":{"error":{"message":"State modification is not enabled for FLA enterprise accounts","type":"INVALID_PERMISSIONS"}}},"Non-managed user account":{"description":"Can only manage information of managed users.","summary":"Non-managed user account","value":{"error":{"message":"User is not managed by the enterprise account","type":"INVALID_PERMISSIONS"}}}}}},"description":"Placeholder Description"},"422":{"content":{"application\u002Fjson":{"examples":{"Email in use failure":{"description":"Email cannot be taken already.","summary":"Email in use failure","value":{"error":{"message":"Email already in use","type":"EMAIL_ALREADY_IN_USE"}}},"ID or email not specified":{"description":"Either id or email must be supplied in the request body.","summary":"ID or email not specified","value":{"error":{"message":"Invalid request: either ID or email must be specified. Check your request data.","type":"INVALID_REQUEST_UNKNOWN"}}},"Must own target domain":{"description":"Enterprise account must own target email domain.","summary":"Must own target domain","value":{"error":{"message":"Target email domain not owned by this enterprise account","type":"TARGET_EMAIL_DOMAIN_NOT_OWNED_BY_ENTERPRISE"}}},"Service accounts must be on verified domains":{"description":"A service account email must be on a verified email domain","summary":"Service accounts must be on verified domains","value":{"error":{"message":"Service Account must be on verified enterprise email domain","type":"SERVICE_ACCOUNT_MUST_BE_ON_VERIFIED_DOMAIN"}}},"Two factor error":{"description":"Email cannot be changed while the user has two factor authentication enabled.","summary":"Two factor error","value":{"error":{"message":"Cannot change email when two factor authentication is enabled","type":"CANNOT_CHANGE_EMAIL_WHILE_TWO_FACTOR_ENABLED"}}}}}},"description":"Placeholder Description"}},"security":[{"oauth":["enterprise.user:write"]}],"summary":"Manage user batched","tags":["user"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"]}},"\u002Fv0\u002Fmeta\u002FenterpriseAccounts\u002F{enterpriseAccountId}\u002Fusers\u002Fclaim":{"parameters":[{"in":"path","name":"enterpriseAccountId","required":true,"schema":{"pattern":"ent[0-9a-zA-Z]{14}$","type":"string"}}],"post":{"description":"Batch manage organizations enterprise account users.\nThis endpoint allows you to change a user's membership status from being unmanaged to being an organization member, and vice versa. To use this endpoint, provide either the user's `id` or `email` in the request body. If both are supplied, the `email` will be ignored.\n\nThis endpoint can only be used if your enterprise is not domain capturing.\n\nIn the example request provided, the first two users are successfully processed while all of the remaining users are not processed and are returned in the `errors` array with the reason why they were not able to be processed.\n\nNote that the domain of the user you are trying to claim must be verified in your organization's Admin Panel. If the domain is not verified, the user will not be claimed and will be returned in the `errors` array.\n\nFor more information on managing users and the different types of users in organizations, please see [our support article](https:\u002F\u002Fsupport.airtable.com\u002Fdocs\u002Fusing-organizations).","operationId":"manage-user-membership","requestBody":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Success Response","summary":"Success response","value":{"users":[{"id":"usrL2PNC5o3H4lBEi","state":"managed"},{"email":"foo@bar.com","state":"unmanaged"},{"email":"bam@bam.com","state":"managed"},{"id":"usrsOEchC9xuwRgKk","state":"unmanaged"},{"id":"usrL2PNC5o3H4lBEi","state":"managed"},{"email":"user@unverifiedDomain.com","state":"managed"},{"email":"user@externalDomain.com","state":"managed"},{"id":"usrGcrteE5fUMqq0R","state":"managed"},{"id":"usrqccqnMB2eHylqB","state":"managed"},{"id":"usrogvSbotRtzdtZW","state":"unmanaged"},{"email":"foo@bam.com","state":"unmanaged"},{"id":"usrcQYqV90vkqUDXv","state":"unmanaged"}]}}},"schema":{"properties":{"users":{"items":{"properties":{"email":{"type":"string"},"id":{"description":"A user ID","type":"string"},"state":{"description":"[managed](\u002Fapi\u002Forg-management-glossary#managed-user) | [unmanaged](\u002Fapi\u002Forg-management-glossary#unmanaged-user)","enum":["managed","unmanaged"],"type":"string"}},"required":["state"],"type":"object"},"type":"array"}},"required":["users"],"type":"object"}}}},"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Success Response","summary":"Success response","value":{"errors":[{"email":"bam@bam.com","message":"User not found","type":"NOT_FOUND"},{"id":"usrsOEchC9xuwRgKk","message":"User not found","type":"MODEL_ID_NOT_FOUND"},{"id":"usrL2PNC5o3H4lBEi","message":"Duplicate user","type":"DUPLICATE"},{"email":"user@unverifiedDomain.com","message":"Domain is unverified, please verify your domain or request to manage user instead","type":"DOMAIN_IS_UNVERIFIED"},{"email":"user@externalDomain.com","message":"User email domain is not part of this enterprise","type":"NOT_FOUND"},{"id":"usrGcrteE5fUMqq0R","message":"User is already claimed by enterprise account entUBq2RGdihxl3vU","type":"ALREADY_CLAIMED"},{"id":"usrqccqnMB2eHylqB","message":"User is already claimed by this enterprise account","type":"ALREADY_CLAIMED"},{"id":"usrogvSbotRtzdtZW","message":"User is not claimed by this enterprise account","type":"NOT_CLAIMED"},{"id":"foo@bam.com","message":"Service accounts cannot be unmanaged","type":"SERVICE_ACCOUNT"},{"id":"usrcQYqV90vkqUDXv","message":"Deactivated users cannot be unmanaged","type":"DEACTIVATED_USER"}]}}},"schema":{"properties":{"errors":{"items":{"properties":{"email":{"type":"string"},"id":{"type":"string"},"message":{"type":"string"},"type":{"type":"string"}},"required":["type","message"],"type":"object"},"type":"array"}},"required":["errors"],"type":"object"}}},"description":"Placeholder Description"},"422":{"content":{"application\u002Fjson":{"examples":{"ID or email not specified":{"description":"Either id or email must be supplied in the request body, or there were no valid users in your request.","summary":"ID or email not specified","value":{"error":{"message":"Invalid request: either ID or email must be specified. Check your request data.","type":"INVALID_REQUEST_UNKNOWN"}}}}}},"description":"Placeholder Description"}},"security":[{"oauth":["enterprise.user:write"]}],"summary":"Manage user membership","tags":["user"],"x-airtable-auth-methods":["personalAccessToken","oauthAccessToken"]}},"\u002Fv0\u002Fmeta\u002FenterpriseAccounts\u002F{enterpriseAccountId}\u002Fusers\u002FgrantAdminAccess":{"parameters":[{"in":"path","name":"enterpriseAccountId","required":true,"schema":{"pattern":"ent[0-9a-zA-Z]{14}$","type":"string"}}],"post":{"description":"Grant admin access to users. To use this endpoint, provide either the user's `id` or `email` in the request body. If both are supplied, the `email` will be ignored.\n\nIn the example request provided, the first two users are successfully processed while all of the remaining users are not processed and are returned in the `errors` array with the reason why they were not able to be processed.","operationId":"grant-admin-access","requestBody":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Success response","summary":"Success response","value":{"users":[{"id":"usrL2PNC5o3H4lBEi"},{"email":"foo@bar.com"},{"email":"bam@bam.com"},{"id":"usrsOEchC9xuwRgKk"},{"email":"foo@bam.com"},{"id":"usrGcrteE5fUMqq0R"}]}}},"schema":{"properties":{"users":{"items":{"properties":{"email":{"type":"string"},"id":{"description":"A user ID","type":"string"}},"type":"object"},"type":"array"}},"required":["users"],"type":"object"}}}},"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Success response","summary":"Success response","value":{"errors":[{"email":"bam@bam.com","message":"User not found","type":"NOT_FOUND"},{"id":"usrsOEchC9xuwRgKk","message":"User not found","type":"USER_ID_NOT_FOUND"},{"email":"foo@bam.com","message":"User is already an admin","type":"USER_ALREADY_ADMIN"},{"id":"usrGcrteE5fUMqq0R","message":"User is not a member of this enterprise account or has an email not associated with this enterprise account","type":"USER_NOT_MEMBER_OF_ENTERPRISE_ACCOUNT"}]}}},"schema":{"properties":{"errors":{"items":{"properties":{"email":{"type":"string"},"id":{"description":"A user ID","type":"string"},"message":{"type":"string"},"type":{"type":"string"}},"required":["type"],"type":"object"},"type":"array"}},"required":["errors"],"type":"object"}}},"description":"Placeholder Description"}},"security":[{"oauth":["enterprise.user:write"]}],"summary":"Grant admin access","tags":["user"],"x-airtable-auth-methods":["personalAccessToken","oauthAccessToken"]}},"\u002Fv0\u002Fmeta\u002FenterpriseAccounts\u002F{enterpriseAccountId}\u002Fusers\u002FrevokeAdminAccess":{"parameters":[{"in":"path","name":"enterpriseAccountId","required":true,"schema":{"pattern":"ent[0-9a-zA-Z]{14}$","type":"string"}}],"post":{"description":"Revokes admin access from users. To use this endpoint, provide either the user's `id` or `email` in the request body. If both are supplied, the `email` will be ignored.\n\nIn the example request provided, the first two users are successfully processed while all of the remaining users are not processed and are returned in the `errors` array with the reason why they were not able to be processed.\n\nNote that you can only revoke directly assigned admin access.","operationId":"revoke-admin-access","requestBody":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Success response","summary":"Success response","value":{"users":[{"id":"usrL2PNC5o3H4lBEi"},{"email":"foo@bar.com"},{"email":"bam@bam.com"},{"id":"usrsOEchC9xuwRgKk"},{"email":"foo@bam.com"}]}}},"schema":{"properties":{"users":{"items":{"properties":{"email":{"type":"string"},"id":{"description":"A user ID","type":"string"}},"type":"object"},"type":"array"}},"required":["users"],"type":"object"}}}},"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Success response","summary":"Success response","value":{"errors":[{"email":"bam@bam.com","message":"User not found","type":"NOT_FOUND"},{"id":"usrsOEchC9xuwRgKk","message":"User not found","type":"USER_ID_NOT_FOUND"},{"email":"foo@bam.com","message":"User is not an assigned admin","type":"USER_NOT_ASSIGNED_ADMIN"}]}}},"schema":{"properties":{"errors":{"items":{"properties":{"email":{"type":"string"},"id":{"description":"A user ID","type":"string"},"message":{"type":"string"},"type":{"type":"string"}},"required":["type"],"type":"object"},"type":"array"}},"required":["errors"],"type":"object"}}},"description":"Placeholder Description"}},"security":[{"oauth":["enterprise.user:write"]}],"summary":"Revoke admin access","tags":["user"],"x-airtable-auth-methods":["personalAccessToken","oauthAccessToken"]}},"\u002Fv0\u002Fmeta\u002FenterpriseAccounts\u002F{enterpriseAccountId}\u002Fusers\u002FupdateUserLicenseTypes":{"parameters":[{"in":"path","name":"enterpriseAccountId","required":true,"schema":{"pattern":"ent[0-9a-zA-Z]{14}$","type":"string"}}]},"\u002Fv0\u002Fmeta\u002FenterpriseAccounts\u002F{enterpriseAccountId}\u002Fusers\u002F{userId}":{"delete":{"description":"Delete ELA enterprise account [internal](\u002Fapi\u002Forg-management-glossary#internal-users) users and \"claiming\" enterprise account [managed](\u002Fapi\u002Forg-management-glossary#managed-user) users.","operationId":"delete-user-by-id","parameters":[],"responses":{"200":{"content":{"application\u002Fjson":{"schema":{"type":"null"}}},"description":"Placeholder Description"},"403":{"content":{"application\u002Fjson":{"examples":{"Action on self failure":{"description":"Don't deactivate yourself or you might lose access. If action must be performed, add another admin.","summary":"Action on self failure","value":{"error":{"message":"Cannot perform action on self","type":"INVALID_PERMISSIONS"}}},"Cannot delete sole owner":{"description":"If a workspace has more than one collaborator, it must have at least one owner. So the sole owner cannot be deleted.","summary":"Cannot delete sole owner","value":{"error":{"message":"Cannot delete sole owner of a workspace with other collaborators","type":"INVALID_PERMISSIONS"}}},"External user account":{"description":"Cannot modify external user state since they are not considered part of the enterprise account.","summary":"External user account","value":{"error":{"message":"User does not belong to the enterprise email domain","type":"INVALID_PERMISSIONS"}}},"FLA account error":{"description":"The provisioned and deactivated states apply only to ELA and \"claiming\" enterprise accounts. FLA users are always provisioned.","summary":"FLA account error","value":{"error":{"message":"State modification is not enabled for FLA enterprise accounts","type":"INVALID_PERMISSIONS"}}},"Non-managed user account":{"description":"Can only manage information of managed users.","summary":"Non-managed user account","value":{"error":{"message":"User is not managed by the enterprise account","type":"INVALID_PERMISSIONS"}}}}}},"description":"Placeholder Description"}},"security":[{"oauth":["enterprise.user:write"]}],"summary":"Delete user by id","tags":["user"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"]},"get":{"description":"Returns basic information relevant to both [internal](\u002Fapi\u002Forg-management-glossary#internal-user) and [external](\u002Fapi\u002Forg-management-glossary#external-user) user.","operationId":"get-user-by-id","parameters":[{"in":"query","name":"include","schema":{"description":"If specified, collaborations, aggregated, and\u002For descendants keys will be included in the response object.\nOtherwise, they will be left out.","items":{"enum":["collaborations","aggregated","descendants"],"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Example response":{"description":"Simple example","summary":"Example response","value":{"collaborations":{"baseCollaborations":[{"baseId":"appLkNDICXNqxSDhG","createdTime":"2019-01-03T12:33:12.421Z","grantedByUserId":"usrqccqnMB2eHylqB","permissionLevel":"edit"}],"interfaceCollaborations":[{"baseId":"appLkNDICXNqxSDhG","createdTime":"2019-01-03T12:33:12.421Z","grantedByUserId":"usrqccqnMB2eHylqB","interfaceId":"pbdyGA3PsOziEHPDE","permissionLevel":"edit"}],"workspaceCollaborations":[{"createdTime":"2019-01-03T12:33:12.421Z","grantedByUserId":"usrGcrteE5fUMqq0R","permissionLevel":"owner","workspaceId":"wspmhESAta6clCCwF"}]},"createdTime":"2019-01-03T12:33:12.421Z","email":"foo@bar.com","groups":[{"id":"ugp1mKGb3KXUyQfOZ"},{"id":"ugpR8ZT9KtIgp8Bh3"}],"id":"usrL2PNC5o3H4lBEi","invitedToAirtableByUserId":"usrsOEchC9xuwRgKk","isManaged":true,"isServiceAccount":false,"isSsoRequired":true,"isTwoFactorAuthEnabled":false,"lastActivityTime":"2019-01-03T12:33:12.421Z","name":"foo baz","state":"provisioned"}}},"schema":{"properties":{"aggregated":{"description":"The user's aggregated values across this enterprise account and its descendants.\nOnly returned when the user is on a claimed domain and the enterprise account has the Enterprise Hub feature enabled.","properties":{"collaborations":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FCollaborations","description":"The user's direct collaborations on workspaces, bases and interfaces associated with this enterprise account and its descendants.\nExcludes collaborations from groups."},"groups":{"description":"This field specifies the groups associated with this enterprise account and its descendants that the user belongs to.","items":{"properties":{"id":{"description":"A user group ID","type":"string"}},"required":["id"],"type":"object"},"type":"array"},"isAdmin":{"description":"Whether the user has directly assigned admin rights over this enterprise account or its descendants.","type":"boolean"},"lastActivityTime":{"anyOf":[{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},{"type":"null"}],"description":"Most recent time the user interacted with this enterprise account and its descendants' data. null if never."}},"required":["lastActivityTime"],"type":"object"},"collaborations":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FCollaborations","description":"The user's direct collaborations on workspaces, bases and interfaces associated with this enterprise account.\nExcludes collaborations from groups."},"createdTime":{"description":"When user was created. This field is only returned when user is internal.","type":"string"},"descendants":{"additionalProperties":{"properties":{"collaborations":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FCollaborations"},"groups":{"items":{"properties":{"id":{"description":"A user group ID","type":"string"}},"required":["id"],"type":"object"},"type":"array"},"isAdmin":{"type":"boolean"},"isManaged":{"type":"boolean"},"lastActivityTime":{"anyOf":[{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},{"type":"null"}]}},"required":["lastActivityTime"],"type":"object"},"description":"The user's values per descendant enterprise account.\nOnly returned when the user is on a claimed domain and the enterprise account has the Enterprise Hub feature enabled.","type":"object"},"email":{"type":"string"},"enterpriseUserType":{"description":"The type of user. Only returned if the enterprise has group mappings active and only if user is internal.","enum":["accessReadOnlyShareLinks","full"],"type":"string"},"groups":{"description":"This field specifies the groups associated with this enterprise account that the user belongs to.\nThis field is only returned when the user is internal.","items":{"properties":{"id":{"description":"A user group ID","type":"string"}},"required":["id"],"type":"object"},"type":"array"},"id":{"description":"A user ID","type":"string"},"invitedToAirtableByUserId":{"anyOf":[{"description":"A user ID","type":"string"},{"type":"null"}],"description":"This field is only returned when either the inviter or the user is internal.\nIf there is no inviter, this field is null.\nIf user is internal but inviter is external, this field is \"usrEXTERNREDACTED\"."},"isAdmin":{"description":"Whether the user has directly assigned admin rights over this enterprise account. Only returned when\nthe user is on a claimed domain.\nNote: if a user is a super admin but is not directly assigned admin rights over this enterprise account, this field is `false`.","type":"boolean"},"isManaged":{"description":"Whether the user is managed by this enterprise account. Only returned when the user is on a claimed domain.","type":"boolean"},"isServiceAccount":{"description":"Whether the user is a [service account](https:\u002F\u002Fsupport.airtable.com\u002Fdocs\u002Fen\u002Fservice-accounts-overview).","type":"boolean"},"isSsoRequired":{"description":"Whether the user is required to authenticate through their administrating enterprise's identity provider to login.\nFalse if user is not on an enterprise.","type":"boolean"},"isSuperAdmin":{"description":"Whether the user has super admin rights over this enterprise account. Only returned when the user is on a claimed\ndomain and the enterprise account has the Enterprise Hub feature enabled.","type":"boolean"},"isTwoFactorAuthEnabled":{"description":"Whether the user configured a second authentication method when logging in to Airtable through username\u002Fpassword auth.","type":"boolean"},"lastActivityTime":{"anyOf":[{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},{"type":"null"}],"description":"Most recent time the user interacted with this enterprise account's data. null if never."},"name":{"type":"string"},"state":{"description":"[provisioned](\u002Fapi\u002Forg-management-glossary#provisioned-user) | [deactivated](\u002Fapi\u002Forg-management-glossary#deactivated-user)","enum":["provisioned","deactivated"],"type":"string"}},"required":["id","state","email","name","lastActivityTime","isTwoFactorAuthEnabled","isSsoRequired","isServiceAccount"],"type":"object"}}},"description":"Placeholder Description"}},"security":[{"oauth":["enterprise.user:read"]}],"summary":"Get user by id","tags":["user"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"]},"parameters":[{"in":"path","name":"enterpriseAccountId","required":true,"schema":{"pattern":"ent[0-9a-zA-Z]{14}$","type":"string"}},{"in":"path","name":"userId","required":true,"schema":{"pattern":"usr[0-9a-zA-Z]{14}$","type":"string"}}],"patch":{"description":"Manage enterprise account [managed](\u002Fapi\u002Forg-management-glossary#managed-user) users.","operationId":"manage-user","requestBody":{"content":{"application\u002Fjson":{"examples":{"Success":{"description":"Success request","summary":"Success","value":{"email":"foo@bar.com","firstName":"Foo","lastName":"Baz","state":"provisioned"}}},"schema":{"properties":{"email":{"description":"Enterprise account must own both the original and destination email domains.\n\n*WARNING:* If SSO is required for your enterprise account, you must follow these steps precisely to\navoid locking the end user out of their account or creating duplicate accounts.\n\n - Use this API to update the user's email to a new value (this effectively logs the user out)\n - Use your SSO provider's (e.g. Okta's) admin panel to update the user's email to the new value\n - Tell the user to log into Airtable with the new email","type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"state":{"description":"[provisioned](\u002Fapi\u002Forg-management-glossary#provisioned-user) | [deactivated](\u002Fapi\u002Forg-management-glossary#deactivated-user)\nCan only change the state of [managed](\u002Fapi\u002Forg-management-glossary#managed-user) users.","enum":["provisioned","deactivated"],"type":"string"}},"required":[],"type":"object"}}}},"responses":{"200":{"content":{"application\u002Fjson":{"examples":{},"schema":{"type":"null"}}},"description":"Placeholder Description"},"403":{"content":{"application\u002Fjson":{"examples":{"Action on self failure":{"description":"Don't deactivate yourself or you might lose access. If action must be performed, add another admin.","summary":"Action on self failure","value":{"error":{"message":"Cannot perform action on self","type":"INVALID_PERMISSIONS"}}},"External user account":{"description":"Cannot modify external user state since they are not considered part of the enterprise account.","summary":"External user account","value":{"error":{"message":"User does not belong to the enterprise email domain","type":"INVALID_PERMISSIONS"}}},"FLA account error":{"description":"The provisioned and deactivated states apply only to ELA and \"claiming\" enterprise accounts. FLA users are always provisioned.","summary":"FLA account error","value":{"error":{"message":"State modification is not enabled for FLA enterprise accounts","type":"INVALID_PERMISSIONS"}}},"Non-managed user account":{"description":"Can only manage information of managed users.","summary":"Non-managed user account","value":{"error":{"message":"User is not managed by the enterprise account","type":"INVALID_PERMISSIONS"}}}}}},"description":"Placeholder Description"},"422":{"content":{"application\u002Fjson":{"examples":{"Email in use failure":{"description":"Email cannot be taken already.","summary":"Email in use failure","value":{"error":{"message":"Email already in use","type":"EMAIL_ALREADY_IN_USE"}}},"Must own target domain":{"description":"Enterprise account must own target email domain.","summary":"Must own target domain","value":{"error":{"message":"Target email domain not owned by this enterprise account","type":"TARGET_EMAIL_DOMAIN_NOT_OWNED_BY_ENTERPRISE"}}},"Service accounts must be on verified domains":{"description":"A service account email must be on a verified email domain","summary":"Service accounts must be on verified domains","value":{"error":{"message":"Service Account must be on verified enterprise email domain","type":"SERVICE_ACCOUNT_MUST_BE_ON_VERIFIED_DOMAIN"}}},"Two factor error":{"description":"Email cannot be changed while the user has two factor authentication enabled.","summary":"Two factor error","value":{"error":{"message":"Cannot change email when two factor authentication is enabled","type":"CANNOT_CHANGE_EMAIL_WHILE_TWO_FACTOR_ENABLED"}}}}}},"description":"Placeholder Description"}},"security":[{"oauth":["enterprise.user:write"]}],"summary":"Manage user","tags":["user"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"]}},"\u002Fv0\u002Fmeta\u002FenterpriseAccounts\u002F{enterpriseAccountId}\u002Fusers\u002F{userId}\u002Flogout":{"parameters":[{"in":"path","name":"enterpriseAccountId","required":true,"schema":{"pattern":"ent[0-9a-zA-Z]{14}$","type":"string"}},{"in":"path","name":"userId","required":true,"schema":{"pattern":"usr[0-9a-zA-Z]{14}$","type":"string"}}],"post":{"description":"Logout the user.\n\nOnly available for ELA and FLA [internal](\u002Fapi\u002Forg-management-glossary#internal-user) enterprise account users and [managed](\u002Fapi\u002Forg-management-glossary#managed-user) \"claiming\" enterprise users.","operationId":"logout-user","requestBody":{"content":{"application\u002Fjson":{"schema":{"properties":{},"required":[],"type":"object"}}}},"responses":{"200":{"content":{"application\u002Fjson":{}},"description":"Placeholder Description"},"403":{"content":{"application\u002Fjson":{"examples":{"Action on self":{"description":"Cannot log yourself out.","summary":"Action on self","value":{"error":{"message":"Cannot perform action on self","type":"INVALID_PERMISSIONS"}}},"Not in domain":{"description":"Cannot logout external users.","summary":"Not in domain","value":{"error":{"message":"User does not belong to the enterprise email domain","type":"INVALID_PERMISSIONS"}}},"Not managed by enterprise":{"description":"Can only logout managed users.","summary":"Not managed by enterprise","value":{"error":{"message":"User is not managed by the enterprise account","type":"INVALID_PERMISSIONS"}}}}}},"description":"Placeholder Description"}},"security":[{"oauth":["enterprise.user:write"]}],"summary":"Logout user","tags":["user"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"]}},"\u002Fv0\u002Fmeta\u002FenterpriseAccounts\u002F{enterpriseAccountId}\u002Fusers\u002F{userId}\u002Fremove":{"parameters":[{"in":"path","name":"enterpriseAccountId","required":true,"schema":{"pattern":"ent[0-9a-zA-Z]{14}$","type":"string"}},{"in":"path","name":"userId","required":true,"schema":{"pattern":"usr[0-9a-zA-Z]{14}$","type":"string"}}],"post":{"description":"Unshare a user from all enterprise workspaces, bases, interfaces, and user groups. If applicable, the user will also have their admin access revoked.\n\nReturns lists of unsharing and sharing actions performed as part of the user removal.","operationId":"remove-user-from-enterprise","requestBody":{"content":{"application\u002Fjson":{"examples":{"Success Response":{"description":"Success Response","summary":"Success Response","value":{"replacementOwnerId":"usrL2PNC5o3H4lBEi"}}},"schema":{"properties":{"isDryRun":{"type":["boolean","null"],"x-airtable-hide-null":true},"removeFromDescendants":{"description":"If true, removes the user from descendant enterprise accounts as well.\nOnly enterprise accounts with the Enterprise Hub feature enabled have descendant enterprise accounts.","type":"boolean"},"replacementOwnerId":{"anyOf":[{"description":"A user ID","type":"string"},{"type":"null"}],"description":"If the user is the sole owner of any workspaces, you must specify a\nreplacementOwnerId to be added as the new owner of such workspaces. If the\nuser is not the sole owner of any workspaces, replacementOwnerId is optional\nand will be ignored if provided.","x-airtable-hide-null":true}},"required":[],"type":"object"}}}},"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success Response":{"description":"Success Response","summary":"Success Response","value":{"shared":{"workspaces":[{"deletedTime":null,"permissionLevel":"owner","userId":"usrL2PNC5o3H4lBEi","workspaceId":"wsp00000000000000","workspaceName":"Workspace name"}]},"unshared":{"bases":[{"baseId":"app00000000000000","baseName":"Base name","deletedTime":null,"formerPermissionLevel":"create","userId":"usr00000000000000"}],"interfaces":[{"baseId":"app00000000000000","deletedTime":null,"formerPermissionLevel":"create","interfaceId":"pgb00000000000000","interfaceName":"Interface name","userId":"usr00000000000000"}],"workspaces":[{"deletedTime":null,"formerPermissionLevel":"owner","userId":"usr00000000000000","workspaceId":"wsp00000000000000","workspaceName":"Workspace name"}]},"wasUserRemovedAsAdmin":true}}},"schema":{"properties":{"shared":{"description":"A list of JSON objects representing workspaces that replacementOwnerId was shared to.","properties":{"workspaces":{"items":{"properties":{"deletedTime":{"anyOf":[{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},{"type":"null"}]},"enterpriseAccountId":{"description":"Only returned when removeFromDescendants is true","type":"string"},"permissionLevel":{"enum":["none","read","comment","edit","create","owner"],"type":"string"},"userId":{"description":"A user ID","type":"string"},"workspaceId":{"type":"string"},"workspaceName":{"type":"string"}},"required":["workspaceId","workspaceName","permissionLevel","deletedTime"],"type":"object"},"type":"array"}},"required":["workspaces"],"type":"object"},"unshared":{"description":"A list of JSON objects representing workspaces, bases, and interfaces the user was\nunshared from.","properties":{"bases":{"items":{"properties":{"baseId":{"description":"Base ID, a unique identifier for a base.","type":"string"},"baseName":{"type":"string"},"deletedTime":{"anyOf":[{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},{"type":"null"}]},"enterpriseAccountId":{"description":"Only returned when removeFromDescendants is true","type":"string"},"formerPermissionLevel":{"enum":["none","read","comment","edit","create","owner"],"type":"string"},"userId":{"description":"A user ID","type":"string"}},"required":["baseId","baseName","userId","formerPermissionLevel","deletedTime"],"type":"object"},"type":"array"},"interfaces":{"items":{"properties":{"baseId":{"description":"Base ID, a unique identifier for a base.","type":"string"},"deletedTime":{"anyOf":[{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},{"type":"null"}]},"enterpriseAccountId":{"description":"Only returned when removeFromDescendants is true","type":"string"},"formerPermissionLevel":{"enum":["none","read","comment","edit","create","owner"],"type":"string"},"interfaceId":{"type":"string"},"interfaceName":{"type":"string"},"userId":{"description":"A user ID","type":"string"}},"required":["interfaceId","baseId","interfaceName","userId","formerPermissionLevel","deletedTime"],"type":"object"},"type":"array"},"workspaces":{"items":{"properties":{"deletedTime":{"anyOf":[{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},{"type":"null"}]},"enterpriseAccountId":{"description":"Only returned when removeFromDescendants is true","type":"string"},"formerPermissionLevel":{"enum":["none","read","comment","edit","create","owner"],"type":"string"},"userId":{"description":"A user ID","type":"string"},"workspaceId":{"type":"string"},"workspaceName":{"type":"string"}},"required":["workspaceId","workspaceName","userId","formerPermissionLevel","deletedTime"],"type":"object"},"type":"array"}},"required":["interfaces","bases","workspaces"],"type":"object"},"wasUserRemovedAsAdmin":{"description":"If removeFromDescendants is true, this field represents whether the user was removed\nas an admin of this enterprise account or its descendants.","type":"boolean"}},"required":["shared","unshared","wasUserRemovedAsAdmin"],"type":"object"}}},"description":"Placeholder Description"},"403":{"content":{"application\u002Fjson":{"examples":{"Cannot perform action on self":{"description":"You are not permitted to perform this operation on yourself. If necessary, another admin should do it.","summary":"Cannot perform action on self","value":{"error":{"message":"You are not permitted to perform this operation on yourself","type":"INVALID_PERMISSIONS"}}},"Email not verified":{"description":"replacementOwnerId, if required, must correspond to a verified user account.","summary":"Email not verified","value":{"error":{"message":"Replacement owner must have verified email","type":"INVALID_PERMISSIONS"}}},"Enterprise invite restrictions":{"description":"replacementOwnerId, if required, must abide by the enteprise account's invite restrictions.","summary":"Enterprise invite restrictions","value":{"error":{"message":"You cannot use that replacementOwnerId because of this enterprise account's invite restrictions","type":"INVALID_PERMISSIONS"}}},"Removing replacement owner":{"description":"TBD","summary":"Removing replacement owner","value":{"error":{"message":"Replacement owner must be different from the users being removed","type":"INVALID_PERMISSIONS"}}},"Removing sole owner":{"description":"If the user is the sole owner of a workspace, replacementOwnerId must be provided in the request body.","summary":"Removing sole owner","value":{"error":{"message":"Replacement owner is required if to-be-removed users are the sole owners on workspace(s)","type":"INVALID_PERMISSIONS"}}},"Replacement owner not found":{"description":"TBD","summary":"Replacement owner not found","value":{"error":{"message":"No user with that replacementOwnerId could be found","type":"INVALID_PERMISSIONS"}}}}}},"description":"Placeholder Description"}},"security":[{"oauth":["enterprise.user:write"]}],"summary":"Remove user from enterprise","tags":["enterprise"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"]}},"\u002Fv0\u002Fmeta\u002Fgroups\u002F{groupId}":{"get":{"description":"Returns basic information relevant to the user group.","operationId":"get-user-group","parameters":[{"in":"query","name":"include","schema":{"description":"If specified, collaborations key will be included in the response object.\nOtherwise it will be left out. You must be a group member or enterprise admin to view this information.","items":{"const":"collaborations","type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success Response":{"description":"Success Response","summary":"Success Response","value":{"collaborations":{"baseCollaborations":[{"baseId":"appLkNDICXNqxSDhG","createdTime":"2021-06-02T07:37:50.000Z","grantedByUserId":"usrogvSbotRtzdtZW","permissionLevel":"create"}],"interfaceCollaborations":[{"baseId":"appLkNDICXNqxSDhG","createdTime":"2019-01-03T12:33:12.421Z","grantedByUserId":"usrqccqnMB2eHylqB","interfaceId":"pbdyGA3PsOziEHPDE","permissionLevel":"edit"}],"workspaceCollaborations":[{"createdTime":"2021-06-02T07:37:48.000Z","grantedByUserId":"usrqccqnMB2eHylqB","permissionLevel":"edit","workspaceId":"wspmhESAta6clCCwF"}]},"createdTime":"2021-06-02T07:37:19.000Z","enterpriseAccountId":"entUBq2RGdihxl3vU","id":"ugp1mKGb3KXUyQfOZ","members":[{"createdTime":"2021-06-02T07:37:19.000Z","email":"foo@bar.com","firstName":"Jane","lastName":"Doe","role":"member","userId":"usrL2PNC5o3H4lBEi"},{"createdTime":"2021-06-02T07:37:19.000Z","email":"foo@bam.com","firstName":"Alex","lastName":"Hay","role":"manager","userId":"usrsOEchC9xuwRgKk"},{"createdTime":"2021-06-02T07:37:19.000Z","email":"bam@bam.com","firstName":"John","lastName":"Dane","role":"member","userId":"usrGcrteE5fUMqq0R"}],"name":"Group name","updatedTime":"2022-09-02T10:10:35:000Z"}}},"schema":{"properties":{"collaborations":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FCollaborations","description":"The group's direct collaborations on workspaces, bases and interfaces."},"createdTime":{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},"enterpriseAccountId":{"description":"The id of the enterprise account that the group is associated with.","type":"string"},"id":{"description":"A user group ID","type":"string"},"members":{"description":"Group members' information.","items":{"properties":{"createdTime":{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},"email":{"type":"string"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"role":{"enum":["manager","member"],"type":"string"},"userId":{"description":"A user ID","type":"string"}},"required":["userId","firstName","lastName","email","role","createdTime"],"type":"object"},"type":"array"},"name":{"type":"string"},"updatedTime":{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"}},"required":["createdTime","enterpriseAccountId","id","members","name","updatedTime"],"type":"object"}}},"description":"Placeholder Description"}},"security":[{"oauth":["enterprise.groups:read"]}],"summary":"Get user group","tags":["userManagement"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"]},"parameters":[{"in":"path","name":"groupId","required":true,"schema":{"pattern":"ugp[0-9a-zA-Z]{14}$","type":"string"}}]},"\u002Fv0\u002Fmeta\u002Fwhoami":{"get":{"description":"Retrieve the user's ID. For OAuth access tokens, the scopes associated with the token used are also returned. For tokens with the `user.email:read` scope, the user's email is also returned.","operationId":"get-user-id-scopes","parameters":[],"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success Response":{"description":"Success Response","summary":"Success Response","value":{"id":"usrL2PNC5o3H4lBEi"}},"Success Response with email":{"description":"Success Response for token with `user.email:read` scope","summary":"Success Response with email","value":{"email":"foo@bar.com","id":"usrL2PNC5o3H4lBEi"}}},"schema":{"properties":{"email":{"description":"The email address of the token's owner.\nOnly returned if the token has the `user.email:read` scope.","type":"string"},"id":{"description":"A user ID","type":"string"},"scopes":{"description":"The scopes the token has.\nOnly returned if accessing via an OAuth access token.","items":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FScope"},"type":"array"}},"required":["id"],"type":"object"}}},"description":"Placeholder Description"}},"summary":"Get user info","tags":["whoAmI"],"x-airtable-auth-methods":["personalAccessToken","oauthAccessToken"],"x-airtable-override-documentation-scopes-and-user-role":{"scopesMarkdown":"No scopes are required for this endpoint","userRoleMarkdown":"Any user"}},"parameters":[]},"\u002Fv0\u002Fmeta\u002Fworkspaces\u002F{workspaceId}":{"delete":{"description":"Deletes the specified workspace.\n\nDeleted workspaces can be restored by workspace owners from the Trash UI, up to the workspace's billing plan retention period.\n\n**WARNING:** If the API user is not currently a workspace owner (one example where this can happen is if the API user is an enterprise admin), the workspace will not show up in the user's Trash.\n\n**WARNING:** Any bases in the deleted workspace will no longer be accessible, be sure to double check whether there are any actively used bases before proceeding with workspace deletion. If you want to retain access to these bases, you should transfer the bases to another workspace before deleting the workspace.","operationId":"delete-workspace","parameters":[],"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Success description","summary":"Success response","value":{"deleted":true,"id":"wspmhESAta6clCCwF"}}},"schema":{"properties":{"deleted":{"const":true,"type":"boolean"},"id":{"type":"string"}},"required":["deleted","id"],"type":"object"}}},"description":"Placeholder Description"},"403":{"content":{"application\u002Fjson":{"examples":{"Not admin":{"description":"Only an admin can perform this action.","summary":"Not admin","value":{"error":{"message":"You are not permitted to perform this operation","type":"INVALID_PERMISSIONS"}}}}}},"description":"Placeholder Description"}},"security":[{"oauth":["workspacesAndBases:manage"]}],"summary":"Delete workspace","tags":["workspace"],"x-airtable-auth-methods":["personalAccessToken","oauthAccessToken"]},"get":{"description":"Returns basic information on the workspace. Does not include deleted collaborators and only include [outstanding](\u002Fapi\u002Forg-management-glossary#outstanding-invite) invites.","operationId":"get-workspace-collaborators","parameters":[{"in":"query","name":"include","schema":{"description":"If specified, collaborators or inviteLinks key\nwill be included in the response object. Otherwise they will be left out.","items":{"enum":["collaborators","inviteLinks"],"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Success Response","summary":"Success response","value":{"baseIds":["appLkNDICXNqxSDhG","appSW9R5uCNmRmfl6"],"collaborators":{"baseCollaborators":[{"baseId":"appLkNDICXNqxSDhG","createdTime":"2019-01-03T12:33:12.421Z","email":"foo@bam.com","grantedByUserId":"usrL2PNC5o3H4lBEi","permissionLevel":"create","userId":"usrsOEchC9xuwRgKk"}],"workspaceCollaborators":[{"createdTime":"2019-01-03T12:33:12.421Z","email":"foo@bar.com","grantedByUserId":"usrL2PNC5o3H4lBEi","permissionLevel":"owner","userId":"usrL2PNC5o3H4lBEi"}]},"createdTime":"2019-01-03T12:33:12.421Z","groupCollaborators":{"baseCollaborators":[{"baseId":"appLkNDICXNqxSDhG","createdTime":"2019-01-03T12:33:12.421Z","grantedByUserId":"usrL2PNC5o3H4lBEi","groupId":"ugpR8ZT9KtIgp8Bh3","name":"group 2","permissionLevel":"create"}],"workspaceCollaborators":[{"createdTime":"2019-01-03T12:33:12.421Z","grantedByUserId":"usrL2PNC5o3H4lBEi","groupId":"ugp1mKGb3KXUyQfOZ","name":"group 1","permissionLevel":"edit"}]},"id":"wspmhESAta6clCCwF","individualCollaborators":{"baseCollaborators":[{"baseId":"appLkNDICXNqxSDhG","createdTime":"2019-01-03T12:33:12.421Z","email":"foo@bam.com","grantedByUserId":"usrL2PNC5o3H4lBEi","permissionLevel":"create","userId":"usrsOEchC9xuwRgKk"}],"workspaceCollaborators":[{"createdTime":"2019-01-03T12:33:12.421Z","email":"foo@bar.com","grantedByUserId":"usrL2PNC5o3H4lBEi","permissionLevel":"owner","userId":"usrL2PNC5o3H4lBEi"}]},"inviteLinks":{"baseInviteLinks":[{"baseId":"appSW9R5uCNmRmfl6","createdTime":"2019-01-03T12:33:12.421Z","id":"invJiqaXmPqq6Ec87","invitedEmail":null,"permissionLevel":"read","referredByUserId":"usrsOEchC9xuwRgKk","restrictedToEmailDomains":[],"type":"multiUse"}],"workspaceInviteLinks":[{"createdTime":"2019-01-03T12:33:12.421Z","id":"invJiqaXmPqq6Ec87","invitedEmail":"bam@bam.com","permissionLevel":"owner","referredByUserId":"usrL2PNC5o3H4lBEi","restrictedToEmailDomains":["foobar.com"],"type":"singleUse"}]},"name":"my first workspace","workspaceRestrictions":{"inviteCreationRestriction":"onlyOwners","shareCreationRestriction":"unrestricted"}}}},"schema":{"properties":{"baseIds":{"items":{"description":"Base ID, a unique identifier for a base.","type":"string"},"type":"array"},"collaborators":{"deprecated":true,"description":"Please use **individualCollaborators** and **groupCollaborators** instead.","properties":{"baseCollaborators":{"items":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FBase-individual-collaborator"},"type":"array"},"workspaceCollaborators":{"items":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FIndividual-Collaborator"},"type":"array"}},"required":["workspaceCollaborators","baseCollaborators"],"type":"object"},"createdTime":{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},"groupCollaborators":{"description":"Groups whose members are collaborating on this workspace.\n\n**Note:** Group cannot be ***owner*** of a workspace.","properties":{"baseCollaborators":{"items":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FBase-group-collaborator"},"type":"array"},"workspaceCollaborators":{"items":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FGroup-Collaborator"},"type":"array"}},"required":["workspaceCollaborators","baseCollaborators"],"type":"object"},"id":{"type":"string"},"individualCollaborators":{"description":"Individual users that are explicitly added as collaborators on the workspace.\nDoes not include users that only have access via membership in a group that has been added as a collaborator.","properties":{"baseCollaborators":{"items":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FBase-individual-collaborator"},"type":"array"},"workspaceCollaborators":{"items":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FIndividual-Collaborator"},"type":"array"}},"required":["workspaceCollaborators","baseCollaborators"],"type":"object"},"inviteLinks":{"properties":{"baseInviteLinks":{"items":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FBase-invite-link"},"type":"array"},"workspaceInviteLinks":{"items":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FInvite-link"},"type":"array"}},"required":["workspaceInviteLinks","baseInviteLinks"],"type":"object"},"name":{"type":"string"},"workspaceRestrictions":{"description":"[Sharing restrictions settings](https:\u002F\u002Fsupport.airtable.com\u002Fdocs\u002Fworkspace-sharing-restrictions) enforced on the workspace.","properties":{"inviteCreationRestriction":{"enum":["unrestricted","onlyOwners"],"type":"string"},"shareCreationRestriction":{"enum":["unrestricted","onlyOwners"],"type":"string"}},"required":["inviteCreationRestriction","shareCreationRestriction"],"type":"object"}},"required":["id","name","createdTime","baseIds","workspaceRestrictions"],"type":"object"}}},"description":"Placeholder Description"}},"security":[{"oauth":["workspacesAndBases:read"]}],"summary":"Get workspace collaborators","tags":["collaborators"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"],"x-airtable-override-documentation-scopes-and-user-role":{"userRoleMarkdown":"Workspace read-only"}},"parameters":[{"in":"path","name":"workspaceId","required":true,"schema":{"pattern":"wsp[0-9a-zA-Z]{14}$","type":"string"}}]},"\u002Fv0\u002Fmeta\u002Fworkspaces\u002F{workspaceId}\u002Fcollaborators":{"parameters":[{"in":"path","name":"workspaceId","required":true,"schema":{"pattern":"wsp[0-9a-zA-Z]{14}$","type":"string"}}],"post":{"description":"Add a new workspace collaborator. Despite the name, this route currently only supports adding one collaborator at a time.","operationId":"add-workspace-collaborator","requestBody":{"content":{"application\u002Fjson":{"examples":{"Success request":{"description":"Example Request","summary":"Success request","value":{"collaborators":[{"permissionLevel":"edit","user":{"id":"usr00000000000000"}}]}}},"schema":{"properties":{"collaborators":{"description":"This endpoint accepts two types of collaborators: **individual user** and **group**.","items":{"anyOf":[{"properties":{"permissionLevel":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FWorkspace-Permission-Levels"},"user":{"properties":{"id":{"description":"A user ID","type":"string"}},"required":["id"],"type":"object"}},"required":["permissionLevel","user"],"type":"object"},{"properties":{"group":{"properties":{"id":{"description":"A user group ID","type":"string"}},"required":["id"],"type":"object"},"permissionLevel":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FWorkspace-Permission-Levels"}},"required":["group","permissionLevel"],"type":"object"}]},"type":"array"}},"required":["collaborators"],"type":"object"}}}},"responses":{"200":{"content":{"application\u002Fjson":{"examples":{}}},"description":"Placeholder Description"},"403":{"content":{"application\u002Fjson":{"examples":{"Add more than one collaborator":{"description":"This route currently supports adding only one collaborator at a time.","summary":"Add more than one collaborator","value":{"error":{"message":"You are only permitted to add one collaborator at a time","type":"INVALID_PERMISSIONS"}}},"Email not verified":{"description":"The userId must correspond to a verified account.","summary":"Email not verified","value":{"error":{"message":"User must be active and email verified","type":"INVALID_PERMISSIONS"}}},"Groups cannot be owners":{"description":"Cannot assign a group as a workspace owner.","summary":"Groups cannot be owners","value":{"error":{"message":"Groups cannot be the owners of a workspace","type":"INVALID_PERMISSIONS"}}}}}},"description":"Placeholder Description"}},"security":[{"oauth":["workspacesAndBases:write"]}],"summary":"Add workspace collaborator","tags":["collaborators"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"],"x-airtable-override-documentation-scopes-and-user-role":{"userRoleMarkdown":"Workspace collaborators subject to [sharing restrictions](https:\u002F\u002Fsupport.airtable.com\u002Fdocs\u002Fworkspace-sharing-restrictions)"}}},"\u002Fv0\u002Fmeta\u002Fworkspaces\u002F{workspaceId}\u002Fcollaborators\u002F{userOrGroupId}":{"delete":{"description":"Delete a workspace collaborator.","operationId":"delete-workspace-collaborator","parameters":[],"responses":{"200":{"content":{"application\u002Fjson":{}},"description":"Placeholder Description"},"403":{"content":{"application\u002Fjson":{"examples":{"Remove sole owner":{"description":"A workspace must have at least 1 owner who's responsible for the workspace's bill. Alternatively, [add another workspace owner](workspace-addWorkspaceCollaborators) before deleting the current owner.","summary":"Remove sole owner","value":{"error":{"message":"Sole owner of a workspace cannot be removed","type":"INVALID_PERMISSIONS"}}}}}},"description":"Placeholder Description"}},"security":[{"oauth":["workspacesAndBases:write"]}],"summary":"Delete workspace collaborator","tags":["collaborators"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"],"x-airtable-override-documentation-scopes-and-user-role":{"userRoleMarkdown":"Workspace collaborators subject to [sharing restrictions](https:\u002F\u002Fsupport.airtable.com\u002Fdocs\u002Fworkspace-sharing-restrictions)"}},"parameters":[{"in":"path","name":"workspaceId","required":true,"schema":{"pattern":"wsp[0-9a-zA-Z]{14}$","type":"string"}},{"in":"path","name":"userOrGroupId","required":true,"schema":{"pattern":"usr[0-9a-zA-Z]{14}|ugp[0-9a-zA-Z]{14}$","type":"string"}}],"patch":{"description":"Updates the permission level of a collaborator on a workspace.","operationId":"update-workspace-collaborator","requestBody":{"content":{"application\u002Fjson":{"examples":{"Success request":{"description":"Example success request","summary":"Success request","value":{"permissionLevel":"read"}}},"schema":{"properties":{"permissionLevel":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FWorkspace-Permission-Levels"}},"required":["permissionLevel"],"type":"object"}}}},"responses":{"200":{"content":{"application\u002Fjson":{"examples":{}}},"description":"Placeholder Description"},"403":{"content":{"application\u002Fjson":{"examples":{"Groups cannot be owners":{"description":"Cannot assign a group as a workspace owner.","summary":"Groups cannot be owners","value":{"error":{"message":"Groups cannot be the owners of a workspace","type":"INVALID_PERMISSIONS"}}},"Not workspace collaborator":{"description":"This route can only be used for users who are already collaborators on the workspace. To add a new collaborator, use the [add workspace collaborator](workspace-addWorkspaceCollaborators) route.","summary":"Not workspace collaborator","value":{"error":{"message":"Invalid permissions","type":"INVALID_PERMISSIONS"}}},"Sole owner":{"description":"A workspace must have at least 1 owner who's responsible for the workspace's bill.","summary":"Sole owner","value":{"error":{"message":"You can not change the permissions of the sole owner of the workspace.","type":"INVALID_PERMISSIONS"}}}}}},"description":"Placeholder Description"}},"security":[{"oauth":["workspacesAndBases:write"]}],"summary":"Update workspace collaborator","tags":["collaborators"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"],"x-airtable-override-documentation-scopes-and-user-role":{"userRoleMarkdown":"Workspace collaborators subject to [sharing restrictions](https:\u002F\u002Fsupport.airtable.com\u002Fdocs\u002Fworkspace-sharing-restrictions)"}}},"\u002Fv0\u002Fmeta\u002Fworkspaces\u002F{workspaceId}\u002Finvites\u002F{inviteId}":{"delete":{"description":"Delete a workspace invite.","operationId":"delete-workspace-invite","parameters":[],"responses":{"200":{"content":{"application\u002Fjson":{}},"description":"Placeholder Description"},"403":{"content":{"application\u002Fjson":{"examples":{"Invite not outstanding":{"description":"The invite must be [outstanding](\u002Fapi\u002Forg-management-glossary#outstanding-invite).","summary":"Invite not outstanding","value":{"error":{"message":"You are not permitted to perform this operation","type":"INVALID_PERMISSIONS"}}}}}},"description":"Placeholder Description"}},"security":[{"oauth":["workspacesAndBases:write"]}],"summary":"Delete workspace invite","tags":["invites"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"],"x-airtable-override-documentation-scopes-and-user-role":{"userRoleMarkdown":"Workspace collaborators subject to [sharing restrictions](https:\u002F\u002Fsupport.airtable.com\u002Fdocs\u002Fworkspace-sharing-restrictions)"}},"parameters":[{"in":"path","name":"workspaceId","required":true,"schema":{"pattern":"wsp[0-9a-zA-Z]{14}$","type":"string"}},{"in":"path","name":"inviteId","required":true,"schema":{"pattern":"inv[0-9a-zA-Z]{14}$","type":"string"}}]},"\u002Fv0\u002Fmeta\u002Fworkspaces\u002F{workspaceId}\u002FmoveBase":{"parameters":[{"in":"path","name":"workspaceId","required":true,"schema":{"pattern":"wsp[0-9a-zA-Z]{14}$","type":"string"}}],"post":{"description":"Move a base between two workspaces owned by the enterprise.","operationId":"move-base","requestBody":{"content":{"application\u002Fjson":{"examples":{"Example request":{"description":"Example Request","summary":"Example request","value":{"baseId":"appLkNDICXNqxSDhG","targetIndex":0,"targetWorkspaceId":"wspmhESAta6clCCwF"}}},"schema":{"properties":{"baseId":{"description":"ID of the base to be moved","type":"string"},"targetIndex":{"description":"The desired index for the base in the target workspace's base order (optional).\nIf provided, targetIndex must be a number between 0 (beginning of the list) and the number of bases\nin the target workspace (end of the list). If targetIndex is not provided,\nthe base will be moved to the end of the list of bases in the target workspace.","type":"number"},"targetWorkspaceId":{"description":"ID of the target workspace of the move. I.e. the workspace that the base will\nbelong to once the move is complete. The target workspace must be in the same enterprise account as the source workspace.","type":"string"}},"required":["baseId","targetWorkspaceId"],"type":"object"}}}},"responses":{"200":{"content":{"application\u002Fjson":{"examples":{},"schema":{"type":"null"}}},"description":"Placeholder Description"},"403":{"content":{"application\u002Fjson":{"examples":{"Not admin":{"description":"Only an admin can perform this action.","summary":"Not admin","value":{"error":{"message":"You are not permitted to perform this operation","type":"INVALID_PERMISSIONS"}}}}}},"description":"Placeholder Description"}},"security":[{"oauth":["workspacesAndBases:manage"]}],"summary":"Move base","tags":["workspace"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"]}},"\u002Fv0\u002Fmeta\u002Fworkspaces\u002F{workspaceId}\u002FupdateRestrictions":{"parameters":[{"in":"path","name":"workspaceId","required":true,"schema":{"pattern":"[0-9a-zA-Z]{17}$","type":"string"}}],"post":{"description":"Update [sharing restrictions settings](https:\u002F\u002Fsupport.airtable.com\u002Fdocs\u002Fworkspace-sharing-restrictions) for the workspace.","operationId":"update-workspace-restrictions","requestBody":{"content":{"application\u002Fjson":{"examples":{"Example request":{"description":"Example Request","summary":"Example request","value":{"inviteCreationRestriction":"onlyOwners"}}},"schema":{"properties":{"inviteCreationRestriction":{"enum":["unrestricted","onlyOwners"],"type":"string"},"shareCreationRestriction":{"enum":["unrestricted","onlyOwners"],"type":"string"}},"type":"object"}}}},"responses":{"200":{"content":{"application\u002Fjson":{"examples":{}}},"description":"Placeholder Description"},"403":{"content":{"application\u002Fjson":{"examples":{"Not owner":{"description":"Only a workspace owner can perform this action.","summary":"Not owner","value":{"error":{"message":"You are not permitted to perform this operation","type":"INVALID_PERMISSIONS"}}}}}},"description":"Placeholder Description"}},"security":[{"oauth":["workspacesAndBases:write"]}],"summary":"Update workspace restrictions","tags":["workspace"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"],"x-airtable-override-documentation-scopes-and-user-role":{"userRoleMarkdown":"Workspace creator"}}},"\u002Fv0\u002F{baseId}\u002F{recordId}\u002F{attachmentFieldIdOrName}\u002FuploadAttachment":{"parameters":[{"in":"path","name":"baseId","required":true,"schema":{"pattern":"app[0-9a-zA-Z]{14}$","type":"string"}},{"in":"path","name":"recordId","required":true,"schema":{"pattern":"rec[0-9a-zA-Z]{14}$","type":"string"}},{"in":"path","name":"attachmentFieldIdOrName","required":true,"schema":{"pattern":"[^\u002F]+$","type":"string"}}],"post":{"description":"Upload an attachment up to 5 MB to an attachment cell via the file bytes directly. \n\nTo upload attachments above this size that are accessible by a public URL, they can be added using https:\u002F\u002Fairtable.com\u002Fdevelopers\u002Fweb\u002Fapi\u002Ffield-model#multipleattachment","operationId":"upload-attachment","requestBody":{"content":{"application\u002Fjson":{"examples":{"Upload a text file":{"description":"Upload a text file to an attachment field","summary":"Upload a text file","value":{"contentType":"text\u002Fplain","file":"SGVsbG8gd29ybGQ=","filename":"sample.txt"}}},"schema":{"properties":{"contentType":{"description":"Content type, e.g. \"image\u002Fjpeg\"","type":"string"},"file":{"description":"The base64 encoded string of the file to be uploaded.","type":"string"},"filename":{"description":"Filename, e.g. \"foo.jpg\"","type":"string"}},"required":["file","filename","contentType"],"type":"object"}}}},"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Upload a text file":{"description":"Upload a text file to an attachment field","summary":"Upload a text file","value":{"createdTime":"2022-02-01T21:25:05.663Z","fields":{"fld00000000000000":[{"filename":"sample.txt","id":"att00000000000000","size":11,"type":"text\u002Fplain","url":"https:\u002F\u002Fv5.airtableusercontent.com\u002Fv3\u002Fu\u002F29\u002F29\u002F1716940800000\u002FffhiecnieIwxisnIBDSAln\u002FfoDeknw_G5CdkdPW1j-U0yUCX9YSaE1EJft3wvXb85pnTY1sKZdYeFvKpsM-fqOa6Bnu5MQVPA_ApINEUXL_E3SAZn6z01VN9Pn9SluhSy4NoakZGapcvl4tuN3jktO2Dt7Ck_gh4oMdsrcV8J-t_A\u002F53m17XmDDHsNtIqzM1PQVnRKutK6damFgNNS5WCaTbI"}]},"id":"rec00000000000000"}}},"schema":{"properties":{"createdTime":{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},"fields":{"additionalProperties":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FCell-value"},"description":"Cell values are keyed by field ID.\n\nSee [Cell Values](\u002Fapi\u002Ffield-model) for more information on cell value response types.","type":"object"},"id":{"description":"Record ID","type":"string"}},"required":["id","createdTime","fields"],"type":"object"}}},"description":"Placeholder Description"}},"summary":"Upload attachment","tags":["record"],"x-airtable-auth-methods":["userApiKey","oauthAccessToken","personalAccessToken"],"x-airtable-is-content-domain":true,"x-airtable-override-documentation-scopes-and-user-role":{"scopesMarkdown":"[data.records:write](\u002Fapi\u002Fscopes#data-records-write)","userRoleMarkdown":"Base editor"}}},"\u002Fv0\u002F{baseId}\u002F{tableIdOrName}":{"delete":{"description":"Deletes records given an array of record ids","operationId":"delete-multiple-records","parameters":[{"examples":{"Success response":{"description":"Success Response","summary":"Success response","value":["rec560UJdUtocSouk","rec3lbPRG4aVqkeOQ"]}},"in":"query","name":"records","schema":{"description":"The recordIds of each record to be deleted. Up to 10 recordIds can be provided.","items":{"description":"Record ID","type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Success Response","summary":"Success response","value":{"records":[{"deleted":true,"id":"rec560UJdUtocSouk"},{"deleted":true,"id":"rec3lbPRG4aVqkeOQ"}]}}},"schema":{"properties":{"records":{"items":{"properties":{"deleted":{"const":true,"type":"boolean"},"id":{"description":"Record ID","type":"string"}},"required":["id","deleted"],"type":"object"},"type":"array"}},"required":["records"],"type":"object"}}},"description":"Placeholder Description"}},"security":[{"oauth":["data.records:write"]}],"summary":"Delete multiple records","tags":["record"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"]},"get":{"description":"List records in a table. Note that table names and table ids can be used interchangeably.\nWe recommend using table IDs so you don't need to modify your API request when your table name changes.\n\nThe server returns one page of records at a time. Each page will contain **pageSize** records, which is 100 by default.\nIf there are more records, the response will contain an **offset**. To fetch the next page of records, include **offset** in the next request's parameters.\nPagination will stop when you've reached the end of your table. If the **maxRecords** parameter is passed, pagination will stop once you've reached this maximum.\n\nReturned records do not include any fields with \"empty\" values, e.g. **\"\"**, **[]**, or **false**.\n\nYou can filter, sort, and format the results with query parameters. Note that these parameters need to be URL encoded.\nYou can use our [API URL encoder tool](https:\u002F\u002Fcodepen.io\u002Fairtable\u002Fpen\u002FMeXqOg) to help with this.\nIf you are using a helper library like [Airtable.js](https:\u002F\u002Fgithub.com\u002FAirtable\u002Fairtable.js), these parameters will be automatically encoded.\n\n**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.\nTo fix this issue you can instead make a POST request to `\u002Fv0\u002F{baseId}\u002F{tableIdOrName}\u002FlistRecords` while passing the parameters within the body of\nthe request instead of the query parameters.","operationId":"list-records","parameters":[{"in":"query","name":"timeZone","schema":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FTimezone","description":"The [time zone](https:\u002F\u002Fsupport.airtable.com\u002Fdocs\u002Fsupported-timezones-for-set-timezone)\nthat should be used to format dates when using `string` as the `cellFormat`. This parameter is\nrequired when using `string` as the `cellFormat`."}},{"in":"query","name":"userLocale","schema":{"description":"The [user locale](https:\u002F\u002Fsupport.airtable.com\u002Fdocs\u002Fsupported-locale-modifiers-for-set-locale)\nthat should be used to format dates when using `string` as the `cellFormat`. This parameter is\nrequired when using `string` as the `cellFormat`.","type":"string"}},{"in":"query","name":"pageSize","schema":{"description":"The number of records returned in each request. Must be less than or equal to 100. Default is 100.","type":["number","null"],"x-airtable-hide-null":true}},{"in":"query","name":"maxRecords","schema":{"description":"The maximum total number of records that will be returned in your requests.\nIf this value is larger than **pageSize** (which is 100 by default), you may have to load multiple pages to reach this total.","type":["number","null"],"x-airtable-hide-null":true}},{"in":"query","name":"offset","schema":{"description":"To fetch the next page of records, include offset from the previous request in the next request's parameters.","type":["string","null"],"x-airtable-hide-null":true}},{"in":"query","name":"view","schema":{"anyOf":[{"type":"string"},{"type":"string"},{"type":"null"}],"description":"The name or ID of a view in the table. If set, only the records in that view will be returned.\nThe records will be sorted according to the order of the view unless the **sort** parameter is included, which overrides that order.\nFields hidden in this view will be returned in the results. To only return a subset of fields, use the **fields** parameter.","x-airtable-hide-null":true}},{"in":"query","name":"sort","schema":{"anyOf":[{"items":{"properties":{"direction":{"enum":["asc","desc",null],"type":["string","null"],"x-airtable-hide-null":true},"field":{"type":"string"}},"required":["field"],"type":"object"},"type":"array"},{"type":"null"}],"description":"A list of sort objects that specifies how the records will be ordered.\nEach sort object must have a **field** key specifying the name of the field to sort on,\nand an optional **direction** key that is either **\"asc\"** or **\"desc\"**. The default direction is **\"asc\"**.\n\nThe **sort** parameter overrides the sorting of the view specified in the **view** parameter.\nIf neither the **sort** nor the **view** parameter is included, the order of records is arbitrary.","x-airtable-hide-null":true}},{"in":"query","name":"filterByFormula","schema":{"description":"A [formula](https:\u002F\u002Fsupport.airtable.com\u002Fdocs\u002Fformula-field-reference) used to filter records.\nThe formula will be evaluated for each record, and if the result is not **0**, **false**, **\"\"**, **NaN**, **[]**,\nor **#Error!** the record will be included in the response. We recommend testing your formula in the Formula field UI\nbefore using it in your API request.\n\nIf combined with the **view** parameter, only records in that view which satisfy the formula will be returned.\n\nThe formula must be encoded first before passing it as a value.\nYou can use [this tool](https:\u002F\u002Fcodepen.io\u002Fairtable\u002Ffull\u002FMeXqOg) to not only encode the formula but also create the entire url you need.\n\nFormulas can use field names, or field id's inside of the formula.\n\n**Note** Airtable's API only accepts request with a URL shorter than 16,000 characters.\nEncoded formulas may cause your requests to exceed this limit. To fix this issue you can instead make a\nPOST request to `\u002Fv0\u002F{baseId}\u002F{tableIdOrName}\u002FlistRecords` while passing the\nparameters within the body of the request instead of the query parameters.","type":["string","null"],"x-airtable-hide-null":true}},{"in":"query","name":"cellFormat","schema":{"anyOf":[{"enum":["json","string"],"type":"string"},{"type":"null"}],"description":"The format that should be used for cell values. Supported values are:\n- **json**: cells will be formatted as JSON, depending on the field type.\n- **string**: cells will be formatted as user-facing strings, regardless of the field type.\nThe **timeZone** and **userLocale** parameters are required when using **string** as the **cellFormat**.\n\n**Note**: You should not rely on the format of these strings, as it is subject to change.\n\nThe default is **json**.","x-airtable-hide-null":true}},{"in":"query","name":"fields","schema":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"Only data for fields whose names or IDs are in this list will be included in the result.\nIf you don't need every field, you can use this parameter to reduce the amount of data transferred.\n\n**Note** Airtable's API only accepts request with a URL shorter than 16,000 characters.\nEncoded formulas may cause your requests to exceed this limit. To fix this issue you can instead make a\nPOST request to `\u002Fv0\u002F{baseId}\u002F{tableIdOrName}\u002FlistRecords` while passing the\nparameters within the body of the request instead of the query parameters.","x-airtable-hide-null":true}},{"in":"query","name":"returnFieldsByFieldId","schema":{"description":"An optional boolean value that lets you return field objects where the key is the field id.\n\nThis defaults to **false**, which returns field objects where the key is the field name.","type":["boolean","null"],"x-airtable-hide-null":true}},{"in":"query","name":"recordMetadata","schema":{"description":"An optional field that, if specified, includes **commentCount** on each record returned.","items":{"const":"commentCount","type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Success Response","summary":"Success response","value":{"records":[{"createdTime":"2022-09-12T21:03:48.000Z","fields":{"Address":"333 Post St","Name":"Union Square","Visited":true},"id":"rec560UJdUtocSouk"},{"createdTime":"2022-09-12T21:03:48.000Z","fields":{"Address":"1 Ferry Building","Name":"Ferry Building"},"id":"rec3lbPRG4aVqkeOQ"}]}}},"schema":{"description":"List of records with fields and cell values","properties":{"offset":{"description":"If there are more records, the response will contain an offset. Pass this offset into the\nnext request to fetch the next page of records.","type":"string"},"records":{"items":{"description":"A single record with field and cell values","properties":{"commentCount":{"description":"The number of comments (if there are any) on the record.\n\nThe `recordMetadata` query parameter must include `\"commentCount\"` in order to receive this.","type":"number"},"createdTime":{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},"fields":{"additionalProperties":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FCell-value"},"description":"Cell values are keyed by either field name or field ID (conditioned on `returnFieldsByFieldId`).\n\nSee [Cell Values](\u002Fapi\u002Ffield-model) for more information on cell value response types.","type":"object"},"id":{"description":"Record ID","type":"string"}},"required":["id","createdTime","fields"],"type":"object"},"type":"array"}},"required":["records"],"type":"object"}}},"description":"Placeholder Description"},"422":{"content":{"application\u002Fjson":{"examples":{"Iteration timeout":{"description":"Iteration may timeout due to client inactivity or server restarts. It may then restart iteration from the beginning.","summary":"Iteration timeout","value":{"error":{"type":"LIST_RECORDS_ITERATOR_NOT_AVAILABLE"}}}}}},"description":"Placeholder Description"}},"security":[{"oauth":["data.records:read"]}],"summary":"List records","tags":["record"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"]},"parameters":[{"in":"path","name":"baseId","required":true,"schema":{"pattern":"app[0-9a-zA-Z]{14}$","type":"string"}},{"in":"path","name":"tableIdOrName","required":true,"schema":{"pattern":"[^\u002F]+$","type":"string"}}],"patch":{"description":"Updates up to 10 records, or upserts them when `performUpsert` is set (see below).\n\nThe URL path accepts both table names and table IDs. We recommend using table IDs so you don't need to modify\nyour API request when your table name changes.\n\nA `PATCH` request will only update the fields included in the request. Fields not included in the request will be unchanged.\nA `PUT` request will perform a destructive update and clear all unincluded cell values.\n\n### Upserts\nSet the `performUpsert` property in your request to enable upsert behavior. When upserting is enabled, the `id` property\nof records becomes optional. Records that do not include `id` will use the fields chosen by [`fieldsToMergeOn`](\u002Fapi\u002Fupdate-multiple-records#request-performupsert-fieldstomergeon)\nas an external ID to match with existing records.\n\n* If zero matches are found, a new record will be created.\n* If one match is found, that record will be updated.\n* If multiple matches are found, the request will fail.\n\nRecords that include `id` will ignore `fieldsToMergeOn` and behave as normal updates. If no record with the given `id` exists,\nthe request will fail and will not create a new record.\nThe API response for upsert requests will additionally include `updatedRecords` and `createdRecords` arrays, indicating which records\nin the `records` array already existed and were updated, or did not exist and were created, respectively.\n\nAirtable reserves the right to throttle upsert requests differently from the [standard rate limit throttling policy](https:\u002F\u002Fairtable.com\u002Fdevelopers\u002Fweb\u002Fapi\u002Frate-limits).\n\n### Typecasting\nSet the `typecast` parameter to `true` to enable typecasting. When typecasting is enabled, Airtable will try to convert string values\nin a record's `fields` object to the appropriate cell value. This conversion is only performed on a best-effort basis.\nTypecasting is disabled by default to ensure your data's integrity, but it may be helpful when integrating with third-party services.","operationId":"update-multiple-records","requestBody":{"content":{"application\u002Fjson":{"examples":{"Success response patch (update only)":{"description":"Success Response Patch (update only)","summary":"Success response patch (update only)","value":{"records":[{"fields":{"Address":"501 Twin Peaks Blvd","Name":"Twin Peaks","Visited":true},"id":"rec560UJdUtocSouk"},{"fields":{"Visited":true},"id":"rec3lbPRG4aVqkeOQ"}]}},"Success response patch (upsert)":{"description":"Success Response Patch (upsert)","summary":"Success response patch (upsert)","value":{"performUpsert":{"fieldsToMergeOn":["Name"]},"records":[{"fields":{"Address":"501 Twin Peaks Blvd","Name":"Twin Peaks","Visited":true}},{"fields":{"Name":"New Park","Visited":true}}]}}},"schema":{"properties":{"performUpsert":{"anyOf":[{"properties":{"fieldsToMergeOn":{"description":"An array with at least one and at most three field names or IDs. IDs must uniquely identify\na single record. These cannot be computed fields (formulas, lookups, rollups), and must be\none of the following types: number, text, long text, single select, multiple select, date.","items":{"type":"string"},"type":"array"}},"required":["fieldsToMergeOn"],"type":"object"},{"type":"null"}],"description":"Enables upsert behavior when set.\n\n**fieldsToMergeOn** will be used as an external ID to match records for updates. For records\nwhere no match is found, a new Airtable record will be created.","x-airtable-hide-null":true},"records":{"items":{"properties":{"fields":{"additionalProperties":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FCell-value"},"type":"object"},"id":{"description":"The ID of the record to update. Required when **performUpsert** is undefined.","type":"string"}},"required":["fields"],"type":"object"},"type":"array"},"returnFieldsByFieldId":{"description":"If set to `true`, records in the API response will key the **fields** object by field ID.\n\nDefaults to `false` when unset, which returns **fields** objects keyed by field name.","type":["boolean","null"],"x-airtable-hide-null":true},"typecast":{"description":"If set to `true`, Airtable will try to convert string values into the appropriate\ncell value. This conversion is only performed on a best-effort basis. To ensure your data's\nintegrity, this should only be used when necessary.\n\nDefaults to `false` when unset.","type":["boolean","null"],"x-airtable-hide-null":true}},"required":["records"],"type":"object"}}}},"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success response patch (update only)":{"description":"Success Response Patch (update only)","summary":"Success response patch (update only)","value":{"records":[{"createdTime":"2022-09-12T21:03:48.000Z","fields":{"Address":"501 Twin Peaks Blvd","Name":"Twin Peaks","Visited":true},"id":"rec560UJdUtocSouk"},{"createdTime":"2022-09-12T21:03:48.000Z","fields":{"Address":"1 Ferry Building","Name":"Ferry Building","Visited":true},"id":"rec3lbPRG4aVqkeOQ"}]}},"Success response patch (upsert)":{"description":"Success Response Patch (upsert)","summary":"Success response patch (upsert)","value":{"createdRecords":["recsHMqsp3GEm3lEi"],"records":[{"createdTime":"2022-09-12T21:03:48.000Z","fields":{"Address":"501 Twin Peaks Blvd","Name":"Twin Peaks","Visited":true},"id":"rec560UJdUtocSouk"},{"createdTime":"2022-11-15T01:02:04.400Z","fields":{"Name":"New Park","Visited":true},"id":"recsHMqsp3GEm3lEi"}],"updatedRecords":["rec560UJdUtocSouk"]}}},"schema":{"anyOf":[{"properties":{"records":{"items":{"properties":{"createdTime":{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},"fields":{"additionalProperties":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FCell-value"},"description":"Cell values are keyed by either field name or field ID (conditioned on `returnFieldsByFieldId`).\n\nSee [Cell Values](\u002Fapi\u002Ffield-model) for more information on cell value response types.","type":"object"},"id":{"description":"Record ID","type":"string"}},"required":["id","createdTime","fields"],"type":"object"},"type":"array"}},"required":["records"],"type":"object"},{"properties":{"createdRecords":{"description":"Record IDs of records created by the upsert request.","items":{"description":"Record ID","type":"string"},"type":"array"},"records":{"items":{"properties":{"createdTime":{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},"fields":{"additionalProperties":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FCell-value"},"description":"Cell values are keyed by either field name or field ID (conditioned on `returnFieldsByFieldId`).\n\nSee [Cell Values](\u002Fapi\u002Ffield-model) for more information on cell value response types.","type":"object"},"id":{"description":"Record ID","type":"string"}},"required":["id","createdTime","fields"],"type":"object"},"type":"array"},"updatedRecords":{"description":"Record IDs of existing records modified by the upsert request.","items":{"description":"Record ID","type":"string"},"type":"array"}},"required":["createdRecords","records","updatedRecords"],"type":"object"}]}}},"description":"Placeholder Description"}},"security":[{"oauth":["data.records:write"]}],"summary":"Update multiple records","tags":["record"],"x-airtable-alternate-request-types":["put"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"]},"post":{"description":"Creates multiple records. Note that table names and table ids can be used interchangeably.\nWe recommend using table IDs so you don't need to modify your API request when your table name changes.\n\nYour request body should include an array of up to 10 record objects. Each of these objects should have one key\nwhose value is an inner object containing your record's cell values, keyed by either field name or field id.\n\nReturns a unique array of the newly created record ids if the call succeeds.\n\nYou can also include a single record object at the top level.","operationId":"create-records","requestBody":{"content":{"application\u002Fjson":{"examples":{"Success response multiple":{"description":"Success Response Multiple","summary":"Success response multiple","value":{"records":[{"fields":{"Address":"333 Post St","Name":"Union Square","Visited":true}},{"fields":{"Address":"1 Ferry Building","Name":"Ferry Building"}}]}},"Success response single":{"description":"Success Response Single","summary":"Success response single","value":{"fields":{"Address":"333 Post St","Name":"Union Square","Visited":true}}}},"schema":{"properties":{"fields":{"anyOf":[{"additionalProperties":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FCell-value"},"type":"object"},{"type":"null"}],"description":"Create **a single** record","x-airtable-hide-null":true},"records":{"anyOf":[{"items":{"properties":{"fields":{"additionalProperties":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FCell-value"},"type":"object"}},"required":["fields"],"type":"object"},"type":"array"},{"type":"null"}],"description":"Create **multiple** records\n\nPass in multiple records to create multiple in one request","x-airtable-hide-null":true},"returnFieldsByFieldId":{"description":"An optional boolean value that lets you return field objects keyed by the field id.\n\nThis defaults to `false`, which returns field objects where the key is the field name.","type":["boolean","null"],"x-airtable-hide-null":true},"typecast":{"description":"The Airtable API will perform best-effort automatic data conversion from string values\nif the typecast parameter is passed in. Automatic conversion is disabled by default to\nensure data integrity, but it may be helpful for integrating with 3rd party data sources.","type":["boolean","null"],"x-airtable-hide-null":true}},"type":"object"}}}},"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success response multiple":{"description":"Success Response Multiple","summary":"Success response multiple","value":{"records":[{"createdTime":"2022-09-12T21:03:48.000Z","fields":{"Address":"333 Post St","Name":"Union Square","Visited":true},"id":"rec560UJdUtocSouk"},{"createdTime":"2022-09-12T21:03:48.000Z","fields":{"Address":"1 Ferry Building","Name":"Ferry Building"},"id":"rec3lbPRG4aVqkeOQ"}]}},"Success response single":{"description":"Success Response Single","summary":"Success response single","value":{"createdTime":"2022-09-12T21:03:48.000Z","fields":{"Address":"333 Post St","Name":"Union Square","Visited":true},"id":"rec560UJdUtocSouk"}}},"schema":{"anyOf":[{"properties":{"records":{"items":{"properties":{"createdTime":{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},"fields":{"additionalProperties":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FCell-value"},"description":"Cell values are keyed by either field name or field ID (conditioned on `returnFieldsByFieldId`).\n\nSee [Cell Values](\u002Fapi\u002Ffield-model) for more information on cell value response types.","type":"object"},"id":{"description":"Record ID","type":"string"}},"required":["id","createdTime","fields"],"type":"object"},"type":"array"}},"required":["records"],"type":"object"},{"properties":{"createdTime":{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},"fields":{"additionalProperties":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FCell-value"},"description":"Cell values are keyed by either field name or field ID (conditioned on `returnFieldsByFieldId`).\n\nSee [Cell Values](\u002Fapi\u002Ffield-model) for more information on cell value response types.","type":"object"},"id":{"description":"Record ID","type":"string"}},"required":["createdTime","fields","id"],"type":"object"}]}}},"description":"Placeholder Description"}},"security":[{"oauth":["data.records:write"]}],"summary":"Create records","tags":["record"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"]},"put":{"description":"Update multiple records. This will perform a **destructive** update and clear all unspecified cell values.\nTable names and table ids can be used interchangeably. We recommend using table IDs so you don't need to modify your API request when your table name changes.\n\nYour request body should include an array of up to 10 record objects. Each of these objects should have an **id** property representing the record ID\nand a **fields** property which contains all of your record's cell values by field name or field id for all of your record's cell values by field name.\n\nTo issue an upsert request, where records would be created if no matching records to update are found, your request body should include a **performUpsert**\nparameter with **fieldsToMergeOn**. **fieldsToMergeOn** is an array with at least one and at most three field names or ids, where combined together,\nrepresent a unique record. Fields to merge on cannot be computed and must be of the following field types: number, text, long text, single select,\nmultiple select, and date. In this case, the id property within record objects is optional. In addition to **records**, **updatedRecords** and **createdRecords**\nwill be included as part of the response, containing record ids to specify which records were created or updated. Airtable reserves the right to throttle\nupsert requests differently from the standard rate limit throttling policy.\n\nAutomatic data conversion for update actions can be enabled via **typecast** parameter. The Airtable API will perform best-effort automatic data conversion\nfrom string values if the **typecast** parameter is passed in. Automatic conversion is disabled by default to ensure data integrity,\nbut it may be helpful for integrating with 3rd party data sources.","operationId":"update-multiple-records-put","requestBody":{"content":{"application\u002Fjson":{"examples":{"Success response put (update only)":{"description":"Success Response Put (update only)","summary":"Success response put (update only)","value":{"records":[{"fields":{"Address":"501 Twin Peaks Blvd","Name":"Twin Peaks","Visited":true},"id":"rec560UJdUtocSouk"},{"fields":{"Address":"1 Ferry Building","Name":"Ferry Building","Visited":true},"id":"rec3lbPRG4aVqkeOQ"}]}}},"schema":{"properties":{"performUpsert":{"anyOf":[{"properties":{"fieldsToMergeOn":{"description":"An array with at least one and at most three field names or IDs. IDs must uniquely identify\na single record. These cannot be computed fields (formulas, lookups, rollups), and must be\none of the following types: number, text, long text, single select, multiple select, date.","items":{"type":"string"},"type":"array"}},"required":["fieldsToMergeOn"],"type":"object"},{"type":"null"}],"description":"Enables upsert behavior when set.\n\n**fieldsToMergeOn** will be used as an external ID to match records for updates. For records\nwhere no match is found, a new Airtable record will be created.","x-airtable-hide-null":true},"records":{"items":{"properties":{"fields":{"additionalProperties":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FCell-value"},"type":"object"},"id":{"description":"The ID of the record to update. Required when **performUpsert** is undefined.","type":"string"}},"required":["fields"],"type":"object"},"type":"array"},"returnFieldsByFieldId":{"description":"If set to `true`, records in the API response will key the **fields** object by field ID.\n\nDefaults to `false` when unset, which returns **fields** objects keyed by field name.","type":["boolean","null"],"x-airtable-hide-null":true},"typecast":{"description":"If set to `true`, Airtable will try to convert string values into the appropriate\ncell value. This conversion is only performed on a best-effort basis. To ensure your data's\nintegrity, this should only be used when necessary.\n\nDefaults to `false` when unset.","type":["boolean","null"],"x-airtable-hide-null":true}},"required":["records"],"type":"object"}}}},"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success response put (update only)":{"description":"Success Response Put (update only)","summary":"Success response put (update only)","value":{"records":[{"createdTime":"2022-09-12T21:03:48.000Z","fields":{"Address":"501 Twin Peaks Blvd","Name":"Twin Peaks","Visited":true},"id":"rec560UJdUtocSouk"},{"createdTime":"2022-09-12T21:03:48.000Z","fields":{"Address":"1 Ferry Building","Name":"Ferry Building","Visited":true},"id":"rec3lbPRG4aVqkeOQ"}]}}},"schema":{"anyOf":[{"properties":{"records":{"items":{"properties":{"createdTime":{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},"fields":{"additionalProperties":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FCell-value"},"description":"Cell values are keyed by either field name or field ID (conditioned on `returnFieldsByFieldId`).\n\nSee [Cell Values](\u002Fapi\u002Ffield-model) for more information on cell value response types.","type":"object"},"id":{"description":"Record ID","type":"string"}},"required":["id","createdTime","fields"],"type":"object"},"type":"array"}},"required":["records"],"type":"object"},{"properties":{"createdRecords":{"description":"Record IDs of records created by the upsert request.","items":{"description":"Record ID","type":"string"},"type":"array"},"records":{"items":{"properties":{"createdTime":{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},"fields":{"additionalProperties":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FCell-value"},"description":"Cell values are keyed by either field name or field ID (conditioned on `returnFieldsByFieldId`).\n\nSee [Cell Values](\u002Fapi\u002Ffield-model) for more information on cell value response types.","type":"object"},"id":{"description":"Record ID","type":"string"}},"required":["id","createdTime","fields"],"type":"object"},"type":"array"},"updatedRecords":{"description":"Record IDs of existing records modified by the upsert request.","items":{"description":"Record ID","type":"string"},"type":"array"}},"required":["createdRecords","records","updatedRecords"],"type":"object"}]}}},"description":"Placeholder Description"}},"security":[{"oauth":["data.records:write"]}],"summary":"Update multiple records (put)","tags":["doNotRender"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"]}},"\u002Fv0\u002F{baseId}\u002F{tableIdOrName}\u002Fsync\u002F{apiEndpointSyncId}":{"parameters":[{"in":"path","name":"baseId","required":true,"schema":{"pattern":"app[0-9a-zA-Z]{14}$","type":"string"}},{"in":"path","name":"tableIdOrName","required":true,"schema":{"pattern":"[^\u002F]+$","type":"string"}},{"in":"path","name":"apiEndpointSyncId","required":true,"schema":{"pattern":"[0-9a-zA-Z]{8}$","type":"string"}}],"post":{"description":"Syncs raw CSV data into a Sync API table.\nYou must first set up a sync from a base (instructions in this [support article](https:\u002F\u002Fsupport.airtable.com\u002Fdocs\u002Fairtable-sync-integration-api-endpoint)).\nThe **apiEndpointSyncId** in the path parameters can be found in the setup flow when\ncreating a new Sync API table, or from the synced table settings.\n\nThe CSV data can contain up to 10k rows, 500 columns, and the HTTP request's size is limited to 2 MB.\n\nThere is a rate limit of 20 requests, per 5 minutes, per base for this endpoint.","operationId":"post-sync-api-endpoint","requestBody":{"content":{"text\u002Fcsv":{"examples":{"Success example":{"description":"CSV sync example","summary":"Success example","value":{"rawCsv":"column1,column2\nrow1-column1,row1-column2\nrow2-column1,row2-column2"}}},"schema":{"properties":{},"required":[],"type":"object"}}}},"responses":{"200":{"content":{"text\u002Fcsv":{"examples":{},"schema":{"properties":{"success":{"const":true,"type":"boolean"}},"required":["success"],"type":"object"}}},"description":"Placeholder Description"}},"security":[{"oauth":["data.records:write","schema.bases:write"]}],"summary":"Sync CSV data","tags":["record"],"x-airtable-auth-methods":["personalAccessToken"],"x-airtable-override-documentation-billing-plan":["pro","enterprise","enterpriseScale"],"x-airtable-override-documentation-scopes-and-user-role":{"userRoleMarkdown":"Base creator"}}},"\u002Fv0\u002F{baseId}\u002F{tableIdOrName}\u002F{recordId}":{"delete":{"description":"Deletes a single record","operationId":"delete-record","parameters":[],"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Success Response","summary":"Success response","value":{"deleted":true,"id":"rec560UJdUtocSouk"}}},"schema":{"properties":{"deleted":{"const":true,"type":"boolean"},"id":{"description":"Record ID","type":"string"}},"required":["id","deleted"],"type":"object"}}},"description":"Placeholder Description"}},"security":[{"oauth":["data.records:write"]}],"summary":"Delete record","tags":["record"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"]},"get":{"description":"Retrieve a single record. Any \"empty\" fields (e.g. **\"\"**, **[]**, or **false**) in the record will not be returned.","operationId":"get-record","parameters":[{"in":"query","name":"cellFormat","schema":{"anyOf":[{"enum":["json","string"],"type":"string"},{"type":"null"}],"description":"The format that should be used for cell values. Supported values are:\n\n - `json:` cells will be formatted as JSON, depending on the field type.\n - `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`.\n\n**Note:** You should not rely on the format of these strings, as it is subject to change.\n\nThe default is `json`.","x-airtable-hide-null":true}},{"in":"query","name":"returnFieldsByFieldId","schema":{"description":"An optional boolean value that lets you return field objects where the key is the field id.\n\nThis defaults to `false`, which returns field objects where the key is the field name.","type":["boolean","null"],"x-airtable-hide-null":true}}],"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Success Response","summary":"Success response","value":{"createdTime":"2022-09-12T21:03:48.000Z","fields":{"Address":"333 Post St","Name":"Union Square","Visited":true},"id":"rec560UJdUtocSouk"}}},"schema":{"properties":{"createdTime":{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},"fields":{"additionalProperties":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FCell-value"},"description":"Cell values are keyed by either field name or field ID (conditioned on `returnFieldsByFieldId`).\n\nSee [Cell Values](\u002Fapi\u002Ffield-model) for more information on cell value response types.","type":"object"},"id":{"description":"Record ID","type":"string"}},"required":["id","createdTime","fields"],"type":"object"}}},"description":"Placeholder Description"}},"security":[{"oauth":["data.records:read"]}],"summary":"Get record","tags":["record"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"]},"parameters":[{"in":"path","name":"baseId","required":true,"schema":{"pattern":"app[0-9a-zA-Z]{14}$","type":"string"}},{"in":"path","name":"tableIdOrName","required":true,"schema":{"pattern":"[^\u002F]+$","type":"string"}},{"in":"path","name":"recordId","required":true,"schema":{"pattern":"rec[0-9a-zA-Z]{14}$","type":"string"}}],"patch":{"description":"Updates a single record. Table names and table ids can be used interchangeably.\nWe recommend using table IDs so you don't need to modify your API request when your table name changes.\nA **PATCH** request will only update the fields you specify, leaving the rest as they were.\nA **PUT** request will perform a destructive update and clear all unspecified cell values.\n\nYour request body should include a **fields** property whose value is an object containing your record's cell values, keyed by either field name or field id.\n\nAutomatic data conversion for update actions can be enabled via **typecast** parameter. The Airtable API will perform best-effort automatic data conversion\nfrom string values if the **typecast** parameter is passed in. Automatic conversion is disabled by default to ensure data integrity,\nbut it may be helpful for integrating with 3rd party data sources.","operationId":"update-record","requestBody":{"content":{"application\u002Fjson":{"examples":{"Success response post":{"description":"Success Response Post","summary":"Success response post","value":{"fields":{"Address":"1 Ferry Building","Name":"Ferry Building","Visited":true}}}},"schema":{"properties":{"fields":{"additionalProperties":{},"type":"object"},"returnFieldsByFieldId":{"description":"An optional boolean value that lets you return field objects keyed by the field id.\n\nThis defaults to `false`, which returns field objects where the key is the field name.","type":["boolean","null"],"x-airtable-hide-null":true},"typecast":{"description":"The Airtable API will perform best-effort automatic data conversion from string values\nif the typecast parameter is passed in. Automatic conversion is disabled by default to\nensure data integrity, but it may be helpful for integrating with 3rd party data sources.","type":["boolean","null"],"x-airtable-hide-null":true}},"required":["fields"],"type":"object"}}}},"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success response post":{"description":"Success Response Post","summary":"Success response post","value":{"createdTime":"2022-09-12T21:03:48.000Z","fields":{"Address":"1 Ferry Building","Name":"Ferry Building","Visited":true},"id":"rec3lbPRG4aVqkeOQ"}}},"schema":{"properties":{"createdTime":{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},"fields":{"additionalProperties":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FCell-value"},"description":"Cell values are keyed by either field name or field ID (conditioned on `returnFieldsByFieldId`).\n\nSee [Cell Values](\u002Fapi\u002Ffield-model) for more information on cell value response types.","type":"object"},"id":{"description":"Record ID","type":"string"}},"required":["createdTime","fields","id"],"type":"object"}}},"description":"Placeholder Description"}},"security":[{"oauth":["data.records:write"]}],"summary":"Update record","tags":["record"],"x-airtable-alternate-request-types":["put"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"]},"put":{"description":"Updates a single record. Any unspecified fields are **not updated**. Table names and table ids can be used interchangeably.\nWe recommend using table IDs so you don't need to modify your API request when your table name changes.\n\nYour request body should include a **fields** property whose value is an object containing your record's cell values, keyed by either field name or field id.\n\nAutomatic data conversion for update actions can be enabled via **typecast** parameter. The Airtable API will perform best-effort automatic data conversion\nfrom string values if the **typecast** parameter is passed in. Automatic conversion is disabled by default to ensure data integrity,\nbut it may be helpful for integrating with 3rd party data sources.","operationId":"update-record-put","requestBody":{"content":{"application\u002Fjson":{"examples":{"Success response patch":{"description":"Success Response Patch","summary":"Success response patch","value":{"fields":{"Visited":true}}}},"schema":{"properties":{"fields":{"additionalProperties":{},"type":"object"},"returnFieldsByFieldId":{"description":"An optional boolean value that lets you return field objects keyed by the field id.\n\nThis defaults to `false`, which returns field objects where the key is the field name.","type":["boolean","null"],"x-airtable-hide-null":true},"typecast":{"description":"The Airtable API will perform best-effort automatic data conversion from string values\nif the typecast parameter is passed in. Automatic conversion is disabled by default to\nensure data integrity, but it may be helpful for integrating with 3rd party data sources.","type":["boolean","null"],"x-airtable-hide-null":true}},"required":["fields"],"type":"object"}}}},"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success response patch":{"description":"Success Response Patch","summary":"Success response patch","value":{"createdTime":"2022-09-12T21:03:48.000Z","fields":{"Address":"1 Ferry Building","Name":"Ferry Building","Visited":true},"id":"rec3lbPRG4aVqkeOQ"}}},"schema":{"properties":{"createdTime":{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},"fields":{"additionalProperties":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FCell-value"},"description":"Cell values are keyed by either field name or field ID (conditioned on `returnFieldsByFieldId`).\n\nSee [Cell Values](\u002Fapi\u002Ffield-model) for more information on cell value response types.","type":"object"},"id":{"description":"Record ID","type":"string"}},"required":["createdTime","fields","id"],"type":"object"}}},"description":"Placeholder Description"}},"security":[{"oauth":["data.records:write"]}],"summary":"Update record (put)","tags":["doNotRender"],"x-airtable-auth-methods":["personalAccessToken","userApiKey","oauthAccessToken"]}},"\u002Fv0\u002F{baseId}\u002F{tableIdOrName}\u002F{recordId}\u002Fcomments":{"get":{"description":"Returns a list of comments for the record from newest to oldest.\n\nNote: Comments in reply to another comment (where `parentCommentId` is set) may not have their parent comment in the same page of results and vice versa.","operationId":"list-comments","parameters":[{"in":"query","name":"pageSize","schema":{"description":"If specified, this will determine the number of comments to return. Must be less than or equal to 100. Default is 100.","type":"number"}},{"in":"query","name":"offset","schema":{"description":"A pointer to a specific comment. If specified, the returned comments will begin at the specified **offset**.\nAn **offset** to the next set of comments will be provided by the API if the number of returned comments exceed the **pageSize**.","type":"string"}}],"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success Response":{"description":"Success Response","summary":"Success Response","value":{"comments":[{"author":{"email":"foo@bar.com","id":"usrL2PNC5o3H4lBEi","name":"Foo Bar"},"createdTime":"2021-03-01T09:00:00.000Z","id":"comB5z37Mg9zaEPw6","lastUpdatedTime":null,"text":"Hello, world!"},{"author":{"email":"foo@bam.com","id":"usrsOEchC9xuwRgKk","name":"Foo Bam"},"createdTime":"2021-03-01T10:00:00.000Z","id":"comeNPu0X9K4Rxzid","lastUpdatedTime":null,"mentioned":{"usrL2PNC5o3H4lBEi":{"displayName":"Foo Bar","email":"foo@bar.com","id":"usrL2PNC5o3H4lBEi","type":"user"}},"parentCommentId":"comB5z37Mg9zaEPw6","text":"Hello world! Hello @[usrL2PNC5o3H4lBEi]"}],"offset":null}}},"schema":{"properties":{"comments":{"items":{"properties":{"author":{"properties":{"email":{"type":"string"},"id":{"description":"A user ID","type":"string"},"name":{"type":"string"}},"required":["id","email"],"type":"object"},"createdTime":{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},"id":{"description":"A comment ID","type":"string"},"lastUpdatedTime":{"anyOf":[{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},{"type":"null"}],"description":"A date timestamp in the ISO format, eg: `\"2018-01-01T00:00:00.000Z\"`, or null if\nthis comment has not been updated since creation."},"mentioned":{"additionalProperties":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FUser-mentioned"},"type":"object"},"parentCommentId":{"description":"The comment ID of the parent comment, if this comment is a threaded reply.","type":"string"},"reactions":{"description":"A list of reactions on this comment. Each entry contains information about the emoji itself,\nalong with metadata about the user who reacted.","items":{"properties":{"emoji":{"properties":{"unicodeCharacter":{"type":"string"}},"required":["unicodeCharacter"],"type":"object"},"reactingUser":{"properties":{"email":{"type":"string"},"name":{"type":"string"},"userId":{"description":"A user ID","type":"string"}},"required":["userId","email"],"type":"object"}},"required":["emoji","reactingUser"],"type":"object"},"type":"array"},"text":{"description":"The comment text itself. Note that this can contain the user mentioned in the text.\nSee [user mentioned](\u002Fapi\u002Fmodel\u002Fuser-mentioned) for more.","type":"string"}},"required":["id","author","text","createdTime","lastUpdatedTime"],"type":"object"},"type":"array"},"offset":{"type":["string","null"]}},"required":["comments","offset"],"type":"object"}}},"description":"Placeholder Description"}},"security":[{"oauth":["data.recordComments:read"]}],"summary":"List comments","tags":["comment"],"x-airtable-auth-methods":["oauthAccessToken","personalAccessToken"]},"parameters":[{"in":"path","name":"baseId","required":true,"schema":{"pattern":"app[0-9a-zA-Z]{14}$","type":"string"}},{"in":"path","name":"tableIdOrName","required":true,"schema":{"pattern":"[^\u002F]+$","type":"string"}},{"in":"path","name":"recordId","required":true,"schema":{"pattern":"rec[0-9a-zA-Z]{14}$","type":"string"}}],"post":{"description":"Creates a comment on a record. [User mentioned](\u002Fapi\u002Fmodel\u002Fuser-mentioned) is supported.","operationId":"create-comment","requestBody":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Success Response","summary":"Success response","value":{"text":"Hello, world!"}},"Success response mention":{"description":"Success Response Mention","summary":"Success response mention","value":{"parentCommentId":"comB5z37Mg9zaEPw6","text":"Hello from a threaded reply, @[usrL2PNC5o3H4lBEi]"}}},"schema":{"properties":{"parentCommentId":{"description":"A comment ID","type":"string"},"text":{"type":"string"}},"required":["text"],"type":"object"}}}},"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Success Response","summary":"Success response","value":{"author":{"email":"foo@bar.com","id":"usrL2PNC5o3H4lBEi","name":"Foo Bar"},"createdTime":"2021-03-01T09:00:00.000Z","id":"comB5z37Mg9zaEPw6","lastUpdatedTime":null,"text":"Hello, world!"}},"Success response mention":{"description":"Success Response Mention","summary":"Success response mention","value":{"author":{"email":"foo@bam.com","id":"usrsOEchC9xuwRgKk","name":"Foo Baz"},"createdTime":"2021-03-01T10:00:00.000Z","id":"comeNPu0X9K4Rxzid","lastUpdatedTime":null,"mentioned":{"usrL2PNC5o3H4lBEi":{"displayName":"Foo Bar","email":"foo@bar.com","id":"usrL2PNC5o3H4lBEi","type":"user"}},"parentCommentId":"comB5z37Mg9zaEPw6","text":"Hello from a threaded reply, @[usrL2PNC5o3H4lBEi]"}}},"schema":{"properties":{"author":{"properties":{"email":{"type":"string"},"id":{"description":"A user ID","type":"string"},"name":{"type":"string"}},"required":["id","email"],"type":"object"},"createdTime":{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},"id":{"description":"A comment ID","type":"string"},"lastUpdatedTime":{"anyOf":[{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},{"type":"null"}],"description":"A date timestamp in the ISO format, eg: `\"2018-01-01T00:00:00.000Z\"`, or null if\nthis comment has not been updated since creation."},"mentioned":{"additionalProperties":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FUser-mentioned"},"type":"object"},"parentCommentId":{"description":"The comment ID of the parent comment, if this comment is a threaded reply.","type":"string"},"reactions":{"description":"A list of reactions on this comment. Each entry contains information about the emoji itself,\nalong with metadata about the user who reacted.","items":{"properties":{"emoji":{"properties":{"unicodeCharacter":{"type":"string"}},"required":["unicodeCharacter"],"type":"object"},"reactingUser":{"properties":{"email":{"type":"string"},"name":{"type":"string"},"userId":{"description":"A user ID","type":"string"}},"required":["userId","email"],"type":"object"}},"required":["emoji","reactingUser"],"type":"object"},"type":"array"},"text":{"description":"The comment text itself. Note that this can contain the user mentioned in the text.\nSee [user mentioned](\u002Fapi\u002Fmodel\u002Fuser-mentioned) for more.","type":"string"}},"required":["id","author","text","createdTime","lastUpdatedTime"],"type":"object"}}},"description":"Placeholder Description"}},"security":[{"oauth":["data.recordComments:write"]}],"summary":"Create comment","tags":["comment"],"x-airtable-auth-methods":["oauthAccessToken","personalAccessToken"]}},"\u002Fv0\u002F{baseId}\u002F{tableIdOrName}\u002F{recordId}\u002Fcomments\u002F{rowCommentId}":{"delete":{"description":"Deletes a comment from a record. Non-admin API users can only delete comments they have created. Enterprise Admins can delete any comment from a record.","operationId":"delete-comment","parameters":[],"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Success Response","summary":"Success response","value":{"deleted":true,"id":"comB5z37Mg9zaEPw6"}}},"schema":{"properties":{"deleted":{"type":"boolean"},"id":{"description":"A comment ID","type":"string"}},"required":["id","deleted"],"type":"object"}}},"description":"Placeholder Description"}},"security":[{"oauth":["data.recordComments:write"]}],"summary":"Delete comment","tags":["comment"],"x-airtable-auth-methods":["oauthAccessToken","personalAccessToken"]},"parameters":[{"in":"path","name":"baseId","required":true,"schema":{"pattern":"app[0-9a-zA-Z]{14}$","type":"string"}},{"in":"path","name":"tableIdOrName","required":true,"schema":{"pattern":"[^\u002F]+$","type":"string"}},{"in":"path","name":"recordId","required":true,"schema":{"pattern":"rec[0-9a-zA-Z]{14}$","type":"string"}},{"in":"path","name":"rowCommentId","required":true,"schema":{"pattern":"com[0-9a-zA-Z]{14}$","type":"string"}}],"patch":{"description":"Updates a comment on a record. API users can only update comments they have created. [User mentioned](\u002Fapi\u002Fmodel\u002Fuser-mentioned) is supported.","operationId":"update-comment","requestBody":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Success Response","summary":"Success response","value":{"text":"Update, world!"}},"Success response mention":{"description":"Success Response Mention","summary":"Success response mention","value":{"text":"Update, @[usrL2PNC5o3H4lBEi]"}}},"schema":{"properties":{"text":{"type":"string"}},"required":["text"],"type":"object"}}}},"responses":{"200":{"content":{"application\u002Fjson":{"examples":{"Success response":{"description":"Success Response","summary":"Success response","value":{"author":{"email":"foo@bar.com","id":"usrL2PNC5o3H4lBEi","name":"Foo Bar"},"createdTime":"2021-03-01T09:00:00.000Z","id":"comB5z37Mg9zaEPw6","lastUpdatedTime":"2021-04-01T09:00:00.000Z","text":"Update, world!"}},"Success response mention":{"description":"Success Response Mention","summary":"Success response mention","value":{"author":{"email":"foo@bam.com","id":"usrsOEchC9xuwRgKk","name":"Foo Baz"},"createdTime":"2021-03-01T10:00:00.000Z","id":"comeNPu0X9K4Rxzid","lastUpdatedTime":"2022-04-01T10:00:00.000Z","mentioned":{"usrL2PNC5o3H4lBEi":{"displayName":"Foo Bar","email":"foo@bar.com","id":"usrL2PNC5o3H4lBEi","type":"user"}},"text":"Update, @[usrL2PNC5o3H4lBEi]"}}},"schema":{"properties":{"author":{"properties":{"email":{"type":"string"},"id":{"description":"A user ID","type":"string"},"name":{"type":"string"}},"required":["id","email"],"type":"object"},"createdTime":{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},"id":{"description":"A comment ID","type":"string"},"lastUpdatedTime":{"anyOf":[{"description":"A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\"","type":"string"},{"type":"null"}],"description":"A date timestamp in the ISO format, eg: `\"2018-01-01T00:00:00.000Z\"`, or null if\nthis comment has not been updated since creation."},"mentioned":{"additionalProperties":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FUser-mentioned"},"type":"object"},"parentCommentId":{"description":"The comment ID of the parent comment, if this comment is a threaded reply.","type":"string"},"reactions":{"description":"A list of reactions on this comment. Each entry contains information about the emoji itself,\nalong with metadata about the user who reacted.","items":{"properties":{"emoji":{"properties":{"unicodeCharacter":{"type":"string"}},"required":["unicodeCharacter"],"type":"object"},"reactingUser":{"properties":{"email":{"type":"string"},"name":{"type":"string"},"userId":{"description":"A user ID","type":"string"}},"required":["userId","email"],"type":"object"}},"required":["emoji","reactingUser"],"type":"object"},"type":"array"},"text":{"description":"The comment text itself. Note that this can contain the user mentioned in the text.\nSee [user mentioned](\u002Fapi\u002Fmodel\u002Fuser-mentioned) for more.","type":"string"}},"required":["id","author","text","createdTime","lastUpdatedTime"],"type":"object"}}},"description":"Placeholder Description"}},"security":[{"oauth":["data.recordComments:write"]}],"summary":"Update comment","tags":["comment"],"x-airtable-auth-methods":["oauthAccessToken","personalAccessToken"]}},"\u002Fv0\u002F{baseId}\u002F{tableIdOrName}\u002F{recordId}\u002Fredactions":{"parameters":[{"in":"path","name":"baseId","required":true,"schema":{"pattern":"app[0-9a-zA-Z]{14}$","type":"string"}},{"in":"path","name":"tableIdOrName","required":true,"schema":{"pattern":"[^\u002F]+$","type":"string"}},{"in":"path","name":"recordId","required":true,"schema":{"pattern":"rec[0-9a-zA-Z]{14}$","type":"string"}}]},"\u002Fv0\u002F{baseId}\u002F{tableIdOrName}\u002F{recordId}\u002Fredactions\u002F{cellHistoryRedactionId}":{"parameters":[{"in":"path","name":"baseId","required":true,"schema":{"pattern":"app[0-9a-zA-Z]{14}$","type":"string"}},{"in":"path","name":"tableIdOrName","required":true,"schema":{"pattern":"[^\u002F]+$","type":"string"}},{"in":"path","name":"recordId","required":true,"schema":{"pattern":"rec[0-9a-zA-Z]{14}$","type":"string"}},{"in":"path","name":"cellHistoryRedactionId","required":true,"schema":{"pattern":"chr[0-9a-zA-Z]{14}$","type":"string"}}]}},"servers":[{"description":"The URL for the Airtable API.","url":"https:\u002F\u002Fapi.airtable.com"}],"tags":[{"name":"table"},{"name":"record"},{"name":"doNotRender"},{"name":"column"},{"name":"comment"},{"name":"base"},{"name":"user"},{"name":"enterprise"},{"name":"whoAmI"},{"name":"collaborators"},{"name":"workspace"},{"name":"invites"},{"name":"shares"},{"name":"block"},{"name":"view"},{"name":"webhooks"},{"name":"auditing"},{"name":"changeEvents"},{"name":"auditLogs"},{"name":"userManagement"},{"name":"scim"}],"x-airtable-fieldInfo":{"publicColumnTypeSchemas":{"properties":{"aiText":{"properties":{"cellValueExample":{"anyOf":[{"properties":{"isStale":{"description":"If the cell should be recomputed due to a dependency change.\nThis can either be a dependent field or the field configuration.","type":"boolean"},"state":{"description":"The current state of the cell.","enum":["empty","loading","generated"],"type":"string"},"value":{"description":"The value that is shown to the user inside of the cell","type":["string","null"]}},"required":["isStale","state","value"],"type":"object"},{"properties":{"errorType":{"description":"A short string that describes the error.","type":"string"},"isStale":{"description":"If the cell should be recomputed due to a dependency change.\nThis can either be a dependent field or the field configuration.","type":"boolean"},"state":{"const":"error","description":"Whether the cell is currently in an error state.","type":"string"},"value":{"description":"The value that is shown to the user inside of the cell","type":["string","null"]}},"required":["errorType","isStale","state","value"],"type":"object"}]},"cellValueV2Example":{"not":{}},"fieldConfigExample":{"properties":{"options":{"properties":{"prompt":{"description":"The prompt that is used to generate the results in the AI field, additional object\ntypes may be added in the future. Currently, this is an array of strings or objects that identify any fields interpolated into the prompt.\n\nThe prompt will not currently be provided if this field config is within another\nfields configuration (like a lookup field)","items":{"anyOf":[{"type":"string"},{"properties":{"field":{"properties":{"fieldId":{"type":"string"}},"required":["fieldId"],"type":"object"}},"required":["field"],"type":"object"}]},"type":"array"},"referencedFieldIds":{"description":"The other fields in the record that are used in the ai field\n\nThe referencedFieldIds will not currently be provided if this field config is within another\nfields configuration (like a lookup field)","items":{"type":"string"},"type":"array"}},"type":"object"},"type":{"const":"aiText","type":"string"}},"required":["type","options"],"type":"object"},"writeCellValueExample":{"not":{}},"writeFieldConfigExample":{"not":{}}},"required":["cellValueExample","fieldConfigExample"],"type":"object"},"autoNumber":{"properties":{"cellValueExample":{"type":"number"},"cellValueV2Example":{"not":{}},"fieldConfigExample":{"properties":{"type":{"const":"autoNumber","type":"string"}},"required":["type"],"type":"object"},"writeCellValueExample":{"not":{}},"writeFieldConfigExample":{"not":{}}},"required":["cellValueExample","fieldConfigExample"],"type":"object"},"barcode":{"properties":{"cellValueExample":{"description":"The barcode object may contain the following two properties, both of which are optional.","properties":{"text":{"description":"Barcode data","type":"string"},"type":{"description":"Barcode symbology, e.g. \"upce\" or \"code39\"","type":["string","null"]}},"required":["text"],"type":"object"},"cellValueV2Example":{"not":{}},"fieldConfigExample":{"properties":{"type":{"const":"barcode","type":"string"}},"required":["type"],"type":"object"},"writeCellValueExample":{"not":{}},"writeFieldConfigExample":{"not":{}}},"required":["cellValueExample","fieldConfigExample"],"type":"object"},"button":{"properties":{"cellValueExample":{"description":"Object providing details about the button configuration.","properties":{"label":{"description":"Button label","type":"string"},"url":{"description":"For \"Open URL\" actions, the computed url value","type":["string","null"]}},"required":["label","url"],"type":"object"},"cellValueV2Example":{"not":{}},"fieldConfigExample":{"properties":{"type":{"const":"button","type":"string"}},"required":["type"],"type":"object"},"writeCellValueExample":{"not":{}},"writeFieldConfigExample":{"not":{}}},"required":["cellValueExample","fieldConfigExample"],"type":"object"},"checkbox":{"properties":{"cellValueExample":{"const":true,"description":"This field is \"true\" when checked and otherwise empty.\n\nYou can write to the cell with \"false\", but the read value will be still be \"empty\" (unchecked).","type":"boolean"},"cellValueV2Example":{"not":{}},"fieldConfigExample":{"description":"Bases on a free or plus plan are limited to using the `'check'` icon and `'greenBright'` color.","properties":{"options":{"properties":{"color":{"description":"The color of the checkbox.","enum":["greenBright","tealBright","cyanBright","blueBright","purpleBright","pinkBright","redBright","orangeBright","yellowBright","grayBright"],"type":"string"},"icon":{"description":"The icon name of the checkbox.","enum":["check","xCheckbox","star","heart","thumbsUp","flag","dot"],"type":"string"}},"required":["color","icon"],"type":"object"},"type":{"const":"checkbox","type":"string"}},"required":["type","options"],"type":"object"},"writeCellValueExample":{"not":{}},"writeFieldConfigExample":{"not":{}}},"required":["cellValueExample","fieldConfigExample"],"type":"object"},"collaborator":{"properties":{"cellValueExample":{"description":"Object providing details about the user collaborator in this field.","properties":{"email":{"description":"User's email address","type":"string"},"id":{"description":"User id or group id","type":"string"},"name":{"description":"User's display name (may be omitted if the user hasn't created an account)","type":"string"},"permissionLevel":{"description":"User's collaborator permission Level\n\nThis is only included if you're observing a webhooks response.","enum":["none","read","comment","edit","create"],"type":"string"},"profilePicUrl":{"description":"User's profile picture\n\nThis is only included if it exists for the user **and** you're observing a webhooks response.","type":"string"}},"required":["id"],"type":"object"},"cellValueV2Example":{"not":{}},"fieldConfigExample":{"properties":{"options":{"type":"object"},"type":{"const":"singleCollaborator","type":"string"}},"required":["type"],"type":"object"},"writeCellValueExample":{"anyOf":[{"properties":{"id":{"description":"The user id, group id of the user","type":"string"}},"required":["id"],"type":"object"},{"properties":{"email":{"description":"The user's email address","type":"string"}},"required":["email"],"type":"object"}]},"writeFieldConfigExample":{"not":{}}},"required":["cellValueExample","fieldConfigExample","writeCellValueExample"],"type":"object"},"count":{"properties":{"cellValueExample":{"type":"number"},"cellValueV2Example":{"not":{}},"fieldConfigExample":{"properties":{"options":{"properties":{"isValid":{"description":"`false` when recordLinkFieldId is null, e.g. the referenced column was deleted.","type":"boolean"},"recordLinkFieldId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["isValid"],"type":"object"},"type":{"const":"count","type":"string"}},"required":["type","options"],"type":"object"},"writeCellValueExample":{"not":{}},"writeFieldConfigExample":{"not":{}}},"required":["cellValueExample","fieldConfigExample"],"type":"object"},"createdBy":{"properties":{"cellValueExample":{"description":"Object providing details about the user collaborator in this field.","properties":{"email":{"description":"User's email address","type":"string"},"id":{"description":"User id or group id","type":"string"},"name":{"description":"User's display name (may be omitted if the user hasn't created an account)","type":"string"},"permissionLevel":{"description":"User's collaborator permission Level\n\nThis is only included if you're observing a webhooks response.","enum":["none","read","comment","edit","create"],"type":"string"},"profilePicUrl":{"description":"User's profile picture\n\nThis is only included if it exists for the user **and** you're observing a webhooks response.","type":"string"}},"required":["id"],"type":"object"},"cellValueV2Example":{"not":{}},"fieldConfigExample":{"properties":{"type":{"const":"createdBy","type":"string"}},"required":["type"],"type":"object"},"writeCellValueExample":{"not":{}},"writeFieldConfigExample":{"not":{}}},"required":["cellValueExample","fieldConfigExample"],"type":"object"},"createdTime":{"properties":{"cellValueExample":{"type":"string"},"cellValueV2Example":{"not":{}},"fieldConfigExample":{"properties":{"options":{"properties":{"result":{"anyOf":[{"properties":{"options":{"properties":{"dateFormat":{"properties":{"format":{"description":"`format` is always provided when reading.\n(`l` for local, `LL` for friendly, `M\u002FD\u002FYYYY` for us, `D\u002FM\u002FYYYY` for european, `YYYY-MM-DD` for iso)","enum":["l","LL","M\u002FD\u002FYYYY","D\u002FM\u002FYYYY","YYYY-MM-DD"],"type":"string"},"name":{"enum":["local","friendly","us","european","iso"],"type":"string"}},"required":["name","format"],"type":"object"}},"required":["dateFormat"],"type":"object"},"type":{"const":"date","type":"string"}},"required":["type","options"],"type":"object","x-airtable-name":"Date field config","x-airtable-redirect-to-relative-path":"field-model#dateonly"},{"properties":{"options":{"properties":{"dateFormat":{"properties":{"format":{"description":"`format` is always provided when reading.\n(`l` for local, `LL` for friendly, `M\u002FD\u002FYYYY` for us, `D\u002FM\u002FYYYY` for european, `YYYY-MM-DD` for iso)","enum":["l","LL","M\u002FD\u002FYYYY","D\u002FM\u002FYYYY","YYYY-MM-DD"],"type":"string"},"name":{"enum":["local","friendly","us","european","iso"],"type":"string"}},"required":["name","format"],"type":"object"},"timeFormat":{"properties":{"format":{"enum":["h:mma","HH:mm"],"type":"string"},"name":{"enum":["12hour","24hour"],"type":"string"}},"required":["name","format"],"type":"object"},"timeZone":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FTimezone"}},"required":["dateFormat","timeFormat","timeZone"],"type":"object"},"type":{"const":"dateTime","type":"string"}},"required":["type","options"],"type":"object","x-airtable-name":"Date-time field config","x-airtable-redirect-to-relative-path":"field-model#dateandtime"}],"description":"This will always be a `date` or `dateTime` field config."}},"type":"object"},"type":{"const":"createdTime","type":"string"}},"required":["type","options"],"type":"object"},"writeCellValueExample":{"not":{}},"writeFieldConfigExample":{"not":{}}},"required":["cellValueExample","fieldConfigExample"],"type":"object"},"currencyNumber":{"properties":{"cellValueExample":{"type":"number"},"cellValueV2Example":{"not":{}},"fieldConfigExample":{"properties":{"options":{"properties":{"precision":{"description":"Indicates the number of digits shown to the right of the decimal point for this field. (0-7 inclusive)","type":"number"},"symbol":{"description":"Currency symbol to use.","type":"string"}},"required":["precision","symbol"],"type":"object"},"type":{"const":"currency","type":"string"}},"required":["type","options"],"type":"object"},"writeCellValueExample":{"not":{}},"writeFieldConfigExample":{"not":{}}},"required":["cellValueExample","fieldConfigExample"],"type":"object"},"dateAndTime":{"properties":{"cellValueExample":{"description":"A date and time.\n\nWhen reading from and writing to a date field, the cell value will always be an\n[ISO 8601](https:\u002F\u002Fwww.iso.org\u002Fiso-8601-date-and-time-format.html)\nformatted date. (Field options specify how it's formatted in the main Airtable UI - format\ncan be used with [moment.js](https:\u002F\u002Fmomentjs.com\u002F) to match that.)\n\nWhen using the Airtable.js library you can also use a [Date object](https:\u002F\u002Fdeveloper.mozilla.org\u002Fen-US\u002Fdocs\u002FWeb\u002FJavaScript\u002FReference\u002FGlobal_Objects\u002FDate).\n\nWhen writing to a `dateTime` field configured with a non `utc` or `client` time zone like `America\u002FLos_Angeles`,\nambiguous string inputs like \"2020-09-05T07:00:00\" and \"2020-09-08\" will be interpreted according\nto the `timeZone` of the field instead of `utc`, and nonambiguous string inputs with zone offset like \"2020-09-05T07:00:00.000Z\"\nand \"2020-09-08T00:00:00-07:00\" will be interpreted correctly as the underlying timestamp.","type":"string"},"cellValueV2Example":{"not":{}},"fieldConfigExample":{"properties":{"options":{"properties":{"dateFormat":{"properties":{"format":{"description":"`format` is always provided when reading.\n(`l` for local, `LL` for friendly, `M\u002FD\u002FYYYY` for us, `D\u002FM\u002FYYYY` for european, `YYYY-MM-DD` for iso)","enum":["l","LL","M\u002FD\u002FYYYY","D\u002FM\u002FYYYY","YYYY-MM-DD"],"type":"string"},"name":{"enum":["local","friendly","us","european","iso"],"type":"string"}},"required":["name","format"],"type":"object"},"timeFormat":{"properties":{"format":{"enum":["h:mma","HH:mm"],"type":"string"},"name":{"enum":["12hour","24hour"],"type":"string"}},"required":["name","format"],"type":"object"},"timeZone":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FTimezone"}},"required":["dateFormat","timeFormat","timeZone"],"type":"object"},"type":{"const":"dateTime","type":"string"}},"required":["type","options"],"type":"object"},"writeCellValueExample":{"not":{}},"writeFieldConfigExample":{"properties":{"options":{"properties":{"dateFormat":{"properties":{"format":{"description":"Format is optional when writing, but it must match\nthe corresponding name if provided.\n\n(`l` for local, `LL` for friendly, `M\u002FD\u002FYYYY` for us, `D\u002FM\u002FYYYY` for european, `YYYY-MM-DD` for iso)","enum":["l","LL","M\u002FD\u002FYYYY","D\u002FM\u002FYYYY","YYYY-MM-DD"],"type":"string"},"name":{"enum":["local","friendly","us","european","iso"],"type":"string"}},"required":["name"],"type":"object"},"timeFormat":{"properties":{"format":{"enum":["h:mma","HH:mm"],"type":"string"},"name":{"enum":["12hour","24hour"],"type":"string"}},"required":["name"],"type":"object"},"timeZone":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FTimezone"}},"required":["dateFormat","timeFormat","timeZone"],"type":"object"},"type":{"const":"dateTime","type":"string"}},"required":["type","options"],"type":"object"}},"required":["cellValueExample","fieldConfigExample","writeFieldConfigExample"],"type":"object"},"dateOnly":{"properties":{"cellValueExample":{"description":"A date.\n\nWhen reading from and writing to a date field, the cell value will always be an\n[ISO 8601](https:\u002F\u002Fwww.iso.org\u002Fiso-8601-date-and-time-format.html)\nformatted date. (Field options specify how it's formatted in the main Airtable UI - format\ncan be used with [moment.js](https:\u002F\u002Fmomentjs.com\u002F) to match that.)\n\nThe date format string follows the moment.js structure documented\n[here](https:\u002F\u002Fmomentjs.com\u002Fdocs\u002F#\u002Fparsing\u002Fstring-format\u002F).\n\nWhen using the Airtable.js library you can also use a [Date object](https:\u002F\u002Fdeveloper.mozilla.org\u002Fen-US\u002Fdocs\u002FWeb\u002FJavaScript\u002FReference\u002FGlobal_Objects\u002FDate).","type":"string"},"cellValueV2Example":{"not":{}},"fieldConfigExample":{"properties":{"options":{"properties":{"dateFormat":{"properties":{"format":{"description":"`format` is always provided when reading.\n(`l` for local, `LL` for friendly, `M\u002FD\u002FYYYY` for us, `D\u002FM\u002FYYYY` for european, `YYYY-MM-DD` for iso)","enum":["l","LL","M\u002FD\u002FYYYY","D\u002FM\u002FYYYY","YYYY-MM-DD"],"type":"string"},"name":{"enum":["local","friendly","us","european","iso"],"type":"string"}},"required":["name","format"],"type":"object"}},"required":["dateFormat"],"type":"object"},"type":{"const":"date","type":"string"}},"required":["type","options"],"type":"object"},"writeCellValueExample":{"not":{}},"writeFieldConfigExample":{"properties":{"options":{"properties":{"dateFormat":{"properties":{"format":{"description":"Format is optional when writing, but it must match\nthe corresponding name if provided.\n\n(`l` for local, `LL` for friendly, `M\u002FD\u002FYYYY` for us, `D\u002FM\u002FYYYY` for european, `YYYY-MM-DD` for iso)","enum":["l","LL","M\u002FD\u002FYYYY","D\u002FM\u002FYYYY","YYYY-MM-DD"],"type":"string"},"name":{"enum":["local","friendly","us","european","iso"],"type":"string"}},"required":["name"],"type":"object"}},"required":["dateFormat"],"type":"object"},"type":{"const":"date","type":"string"}},"required":["type","options"],"type":"object"}},"required":["cellValueExample","fieldConfigExample","writeFieldConfigExample"],"type":"object"},"decimalOrIntegerNumber":{"properties":{"cellValueExample":{"type":"number"},"cellValueV2Example":{"not":{}},"fieldConfigExample":{"properties":{"options":{"properties":{"precision":{"description":"Indicates the number of digits shown to the right of the decimal point for this field. (0-8 inclusive)","type":"number"}},"required":["precision"],"type":"object"},"type":{"const":"number","type":"string"}},"required":["type","options"],"type":"object"},"writeCellValueExample":{"not":{}},"writeFieldConfigExample":{"not":{}}},"required":["cellValueExample","fieldConfigExample"],"type":"object"},"durationNumber":{"properties":{"cellValueExample":{"type":"number"},"cellValueV2Example":{"not":{}},"fieldConfigExample":{"properties":{"options":{"properties":{"durationFormat":{"enum":["h:mm","h:mm:ss","h:mm:ss.S","h:mm:ss.SS","h:mm:ss.SSS"],"type":"string"}},"required":["durationFormat"],"type":"object"},"type":{"const":"duration","type":"string"}},"required":["type","options"],"type":"object"},"writeCellValueExample":{"not":{}},"writeFieldConfigExample":{"not":{}}},"required":["cellValueExample","fieldConfigExample"],"type":"object"},"emailText":{"properties":{"cellValueExample":{"type":"string"},"cellValueV2Example":{"not":{}},"fieldConfigExample":{"properties":{"type":{"const":"email","type":"string"}},"required":["type"],"type":"object"},"writeCellValueExample":{"not":{}},"writeFieldConfigExample":{"not":{}}},"required":["cellValueExample","fieldConfigExample"],"type":"object"},"foreignKey":{"properties":{"cellValueExample":{"description":"Array of linked records IDs from the linked table.","items":{"description":"Record ID","type":"string"},"type":"array"},"cellValueV2Example":{"items":{"properties":{"id":{"description":"Record ID","type":"string"},"name":{"type":"string"}},"required":["id","name"],"type":"object"},"type":"array"},"fieldConfigExample":{"properties":{"options":{"properties":{"inverseLinkFieldId":{"description":"The ID of the field in the linked table that links back\nto this one","type":"string"},"isReversed":{"description":"Whether linked records are rendered in the reverse order from the cell value in the\nAirtable UI (i.e. most recent first).\n\nYou generally do not need to rely on this option.","type":"boolean"},"linkedTableId":{"description":"The ID of the table this field links to","type":"string"},"prefersSingleRecordLink":{"description":"Whether this field prefers to only have a single linked record. While this preference\nis enforced in the Airtable UI, it is possible for a field that prefers single linked\nrecords to have multiple record links (for example, via copy-and-paste or programmatic\nupdates).","type":"boolean"},"viewIdForRecordSelection":{"description":"The ID of the view in the linked table to use when showing\na list of records to select from.","type":"string"}},"required":["linkedTableId","isReversed","prefersSingleRecordLink"],"type":"object"},"type":{"const":"multipleRecordLinks","type":"string"}},"required":["type","options"],"type":"object"},"writeCellValueExample":{"not":{}},"writeFieldConfigExample":{"description":"Creating \"multipleRecordLinks\" fields is supported but updating options for\nexisting \"multipleRecordLinks\" fields is not supported.","properties":{"options":{"properties":{"linkedTableId":{"description":"The ID of the table this field links to","type":"string"},"viewIdForRecordSelection":{"description":"The ID of the view in the linked table\nto use when showing a list of records to select from","type":"string"}},"required":["linkedTableId"],"type":"object"},"type":{"const":"multipleRecordLinks","type":"string"}},"required":["type","options"],"type":"object"}},"required":["cellValueExample","fieldConfigExample","cellValueV2Example","writeFieldConfigExample"],"type":"object"},"formula":{"properties":{"cellValueExample":{"anyOf":[{"type":"string"},{"type":"number"},{"const":true,"type":"boolean"},{"items":{"type":["string","number"]},"type":"array"}],"description":"Computed value - Check options.result to know the resulting field type."},"cellValueV2Example":{"not":{}},"fieldConfigExample":{"properties":{"options":{"properties":{"formula":{"description":"The formula including fields referenced by their IDs. For example, LEFT(4, {Birthday})\nin the Airtable.com formula editor will be returned as LEFT(4, {fldXXX}) via API.","type":"string"},"isValid":{"description":"`false` if the formula contains an error.","type":"boolean"},"referencedFieldIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"All fields in the record that are used in the formula."},"result":{"anyOf":[{"$ref":"#\u002Fcomponents\u002Fschemas\u002FField-type-and-options"},{"type":"null"}],"description":"The resulting field type and options returned by the formula. See other field\ntype configs on this page for the possible values. Can be null if invalid."}},"required":["isValid","formula","referencedFieldIds","result"],"type":"object"},"type":{"const":"formula","type":"string"}},"required":["type","options"],"type":"object","x-airtable-redirect-to-relative-path":"field-model"},"writeCellValueExample":{"not":{}},"writeFieldConfigExample":{"not":{}}},"required":["cellValueExample","fieldConfigExample"],"type":"object"},"lastModifiedBy":{"properties":{"cellValueExample":{"description":"Object providing details about the user collaborator in this field.","properties":{"email":{"description":"User's email address","type":"string"},"id":{"description":"User id or group id","type":"string"},"name":{"description":"User's display name (may be omitted if the user hasn't created an account)","type":"string"},"permissionLevel":{"description":"User's collaborator permission Level\n\nThis is only included if you're observing a webhooks response.","enum":["none","read","comment","edit","create"],"type":"string"},"profilePicUrl":{"description":"User's profile picture\n\nThis is only included if it exists for the user **and** you're observing a webhooks response.","type":"string"}},"required":["id"],"type":"object"},"cellValueV2Example":{"not":{}},"fieldConfigExample":{"properties":{"type":{"const":"lastModifiedBy","type":"string"}},"required":["type"],"type":"object"},"writeCellValueExample":{"not":{}},"writeFieldConfigExample":{"not":{}}},"required":["cellValueExample","fieldConfigExample"],"type":"object"},"lastModifiedTime":{"properties":{"cellValueExample":{"type":"string"},"cellValueV2Example":{"not":{}},"fieldConfigExample":{"properties":{"options":{"properties":{"isValid":{"description":"False if this formula\u002Ffield configuation has an error","type":"boolean"},"referencedFieldIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"The fields to check the last modified time of"},"result":{"anyOf":[{"properties":{"options":{"properties":{"dateFormat":{"properties":{"format":{"description":"`format` is always provided when reading.\n(`l` for local, `LL` for friendly, `M\u002FD\u002FYYYY` for us, `D\u002FM\u002FYYYY` for european, `YYYY-MM-DD` for iso)","enum":["l","LL","M\u002FD\u002FYYYY","D\u002FM\u002FYYYY","YYYY-MM-DD"],"type":"string"},"name":{"enum":["local","friendly","us","european","iso"],"type":"string"}},"required":["name","format"],"type":"object"}},"required":["dateFormat"],"type":"object"},"type":{"const":"date","type":"string"}},"required":["type","options"],"type":"object","x-airtable-name":"Date field config","x-airtable-redirect-to-relative-path":"field-model#dateonly"},{"properties":{"options":{"properties":{"dateFormat":{"properties":{"format":{"description":"`format` is always provided when reading.\n(`l` for local, `LL` for friendly, `M\u002FD\u002FYYYY` for us, `D\u002FM\u002FYYYY` for european, `YYYY-MM-DD` for iso)","enum":["l","LL","M\u002FD\u002FYYYY","D\u002FM\u002FYYYY","YYYY-MM-DD"],"type":"string"},"name":{"enum":["local","friendly","us","european","iso"],"type":"string"}},"required":["name","format"],"type":"object"},"timeFormat":{"properties":{"format":{"enum":["h:mma","HH:mm"],"type":"string"},"name":{"enum":["12hour","24hour"],"type":"string"}},"required":["name","format"],"type":"object"},"timeZone":{"$ref":"#\u002Fcomponents\u002Fschemas\u002FTimezone"}},"required":["dateFormat","timeFormat","timeZone"],"type":"object"},"type":{"const":"dateTime","type":"string"}},"required":["type","options"],"type":"object","x-airtable-name":"Date-time field config","x-airtable-redirect-to-relative-path":"field-model#dateandtime"},{"type":"null"}],"description":"This will always be a `date` or `dateTime` field config."}},"required":["isValid","referencedFieldIds","result"],"type":"object"},"type":{"const":"lastModifiedTime","type":"string"}},"required":["type","options"],"type":"object"},"writeCellValueExample":{"not":{}},"writeFieldConfigExample":{"not":{}}},"required":["cellValueExample","fieldConfigExample"],"type":"object"},"lookup":{"properties":{"cellValueExample":{"description":"Array of cell values from a field in the linked table.","items":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"boolean"},{}]},"type":"array"},"cellValueV2Example":{"properties":{"linkedRecordIds":{"items":{"description":"Record ID","type":"string"},"type":"array"},"valuesByLinkedRecordId":{"additionalProperties":{"items":{},"type":"array"},"propertyNames":{"description":"Record ID"},"type":"object"}},"required":["linkedRecordIds","valuesByLinkedRecordId"],"type":"object"},"fieldConfigExample":{"properties":{"options":{"properties":{"fieldIdInLinkedTable":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The field in the linked table that this field is looking up."},"isValid":{"description":"Is the field currently valid (e.g. false if the linked record field has\nbeen deleted)","type":"boolean"},"recordLinkFieldId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The linked record field in the current table."},"result":{"anyOf":[{"$ref":"#\u002Fcomponents\u002Fschemas\u002FField-type-and-options"},{"type":"null"}],"description":"The field type and options inside of the linked table. See other field\ntype configs on this page for the possible values. Can be null if invalid."}},"required":["isValid","recordLinkFieldId","fieldIdInLinkedTable","result"],"type":"object"},"type":{"const":"multipleLookupValues","type":"string"}},"required":["options","type"],"type":"object"},"writeCellValueExample":{"not":{}},"writeFieldConfigExample":{"not":{}}},"required":["cellValueExample","fieldConfigExample","cellValueV2Example"],"type":"object"},"multiCollaborator":{"properties":{"cellValueExample":{"items":{"description":"Object providing details about the user collaborator in this field.","properties":{"email":{"description":"User's email address","type":"string"},"id":{"description":"User id or group id","type":"string"},"name":{"description":"User's display name (may be omitted if the user hasn't created an account)","type":"string"},"permissionLevel":{"description":"User's collaborator permission Level\n\nThis is only included if you're observing a webhooks response.","enum":["none","read","comment","edit","create"],"type":"string"},"profilePicUrl":{"description":"User's profile picture\n\nThis is only included if it exists for the user **and** you're observing a webhooks response.","type":"string"}},"required":["id"],"type":"object"},"type":"array"},"cellValueV2Example":{"not":{}},"fieldConfigExample":{"properties":{"options":{"type":"object"},"type":{"const":"multipleCollaborators","type":"string"}},"required":["type","options"],"type":"object"},"writeCellValueExample":{"description":"Array of user or group ids\n\nSimilar to [multipleAttachments](\u002Fapi\u002Ffield-model#multiple-attachment) and\n[multipleSelects](\u002Fapi\u002Ffield-model#multi-select), this array-type field will override the current\ncell value when being updated. Be sure to spread the current cell value if you want to keep\nthe currently selected collaborators.","items":{"type":"string"},"type":"array"},"writeFieldConfigExample":{"not":{}}},"required":["cellValueExample","fieldConfigExample","writeCellValueExample"],"type":"object"},"multiSelect":{"properties":{"cellValueExample":{"description":"Array of selected option names.","items":{"type":"string"},"type":"array"},"cellValueV2Example":{"items":{"properties":{"color":{"description":"Optional when the select field is configured to not use colors.\n\nAllowed values: \"blueLight2\", \"cyanLight2\", \"tealLight2\", \"greenLight2\", \"yellowLight2\", \"orangeLight2\", \"redLight2\", \"pinkLight2\", \"purpleLight2\", \"grayLight2\", \"blueLight1\", \"cyanLight1\", \"tealLight1\", \"greenLight1\", \"yellowLight1\", \"orangeLight1\", \"redLight1\", \"pinkLight1\", \"purpleLight1\", \"grayLight1\", \"blueBright\", \"cyanBright\", \"tealBright\", \"greenBright\", \"yellowBright\", \"orangeBright\", \"redBright\", \"pinkBright\", \"purpleBright\", \"grayBright\", \"blueDark1\", \"cyanDark1\", \"tealDark1\", \"greenDark1\", \"yellowDark1\", \"orangeDark1\", \"redDark1\", \"pinkDark1\", \"purpleDark1\", \"grayDark1\"","type":"string"},"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"type":"object"},"type":"array"},"fieldConfigExample":{"properties":{"options":{"properties":{"choices":{"items":{"properties":{"color":{"description":"Optional when the select field is configured to not use colors.\n\nAllowed values: \"blueLight2\", \"cyanLight2\", \"tealLight2\", \"greenLight2\", \"yellowLight2\", \"orangeLight2\", \"redLight2\", \"pinkLight2\", \"purpleLight2\", \"grayLight2\", \"blueLight1\", \"cyanLight1\", \"tealLight1\", \"greenLight1\", \"yellowLight1\", \"orangeLight1\", \"redLight1\", \"pinkLight1\", \"purpleLight1\", \"grayLight1\", \"blueBright\", \"cyanBright\", \"tealBright\", \"greenBright\", \"yellowBright\", \"orangeBright\", \"redBright\", \"pinkBright\", \"purpleBright\", \"grayBright\", \"blueDark1\", \"cyanDark1\", \"tealDark1\", \"greenDark1\", \"yellowDark1\", \"orangeDark1\", \"redDark1\", \"pinkDark1\", \"purpleDark1\", \"grayDark1\"","type":"string"},"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"type":"object"},"type":"array"}},"required":["choices"],"type":"object"},"type":{"const":"multipleSelects","type":"string"}},"required":["options","type"],"type":"object"},"writeCellValueExample":{"not":{}},"writeFieldConfigExample":{"properties":{"options":{"properties":{"choices":{"items":{"properties":{"color":{"description":"Optional when creating an option.","type":"string"},"id":{"description":"This is not specified when creating new options, useful when specifing existing\noptions (for example: reordering options, keeping old options and adding new ones, etc)","type":"string"},"name":{"type":"string"}},"required":["name"],"type":"object"},"type":"array"}},"required":["choices"],"type":"object"},"type":{"const":"multipleSelects","type":"string"}},"required":["options","type"],"type":"object"}},"required":["cellValueExample","fieldConfigExample","cellValueV2Example","writeFieldConfigExample"],"type":"object"},"multilineText":{"properties":{"cellValueExample":{"description":"Multiple lines of text, which may contain \"mention tokens\", e.g.\n`\u003Cairtable:mention id=\"menE1i9oBaGX3DseR\"\u003E@Alex\u003C\u002Fairtable:mention\u003E`","type":"string"},"cellValueV2Example":{"not":{}},"fieldConfigExample":{"properties":{"type":{"const":"multilineText","type":"string"}},"required":["type"],"type":"object"},"writeCellValueExample":{"not":{}},"writeFieldConfigExample":{"not":{}}},"required":["cellValueExample","fieldConfigExample"],"type":"object"},"multipleAttachment":{"properties":{"cellValueExample":{"items":{"properties":{"filename":{"description":"Filename, e.g. \"foo.jpg\"","type":"string"},"height":{"description":"Height, in pixels (these may be available if the attachment is an image)","type":"number"},"id":{"description":"Unique attachment id","type":"string"},"size":{"description":"File size, in bytes","type":"number"},"thumbnails":{"description":"These small, large, and full thumbnails may be available if attachment is an image or document","properties":{"full":{"properties":{"height":{"type":"number"},"url":{"description":"These may be available if the attachment is an image or document. See notes under `url` about the lifetime of these URLs.","type":"string"},"width":{"type":"number"}},"required":["url","width","height"],"type":"object"},"large":{"properties":{"height":{"type":"number"},"url":{"description":"These may be available if the attachment is an image or document. See notes under `url` about the lifetime of these URLs.","type":"string"},"width":{"type":"number"}},"required":["url","width","height"],"type":"object"},"small":{"properties":{"height":{"type":"number"},"url":{"description":"These may be available if the attachment is an image or document. See notes under `url` about the lifetime of these URLs.","type":"string"},"width":{"type":"number"}},"required":["url","width","height"],"type":"object"}},"type":"object"},"type":{"description":"Content type, e.g. \"image\u002Fjpeg\"","type":"string"},"url":{"description":"url, e.g. \"https:\u002F\u002Fv5.airtableusercontent.com\u002Ffoo\".\n\nURLs returned will expire 2 hours after being returned from our API.\nIf you want to persist the attachments, we recommend downloading them instead of saving the URL.\nSee [our support article](https:\u002F\u002Fsupport.airtable.com\u002Fdocs\u002Fairtable-attachment-url-behavior)\nfor more information.","type":"string"},"width":{"description":"Width, in pixels (these may be available if the attachment is an image)","type":"number"}},"required":["id","url","filename","size","type","width","height","thumbnails"],"type":"object"},"type":"array"},"cellValueV2Example":{"not":{}},"fieldConfigExample":{"properties":{"options":{"properties":{"isReversed":{"description":"Whether attachments are rendered in the reverse order from the cell value in the\nAirtable UI (i.e. most recent first).\n\nYou generally do not need to rely on this option.","type":"boolean"}},"required":["isReversed"],"type":"object"},"type":{"const":"multipleAttachments","type":"string"}},"required":["type","options"],"type":"object"},"writeCellValueExample":{"items":{"anyOf":[{"description":"To create new attachments, provide the url and optionally filename.\n\nYou must also provide the id's for any existing attachment objects you wish to keep.\n\nNote that in most cases the API does not currently return an error code for failed attachment object creation\ngiven attachment uploading happens in an asynchronous manner, such cases will manifest with the\nattachment object either being cleared from the cell or persisted with generated URLs that return\nerror responses when queried. If the same attachment URL fails to upload multiple times in a short time interval then\nthe API may return an ATTACHMENTS_FAILED_UPLOADING error code in the details field of the response and the attachment object will\nbe cleared from the cell synchronously.\n\nWe also require URLs used to upload have the https:\u002F\u002F or http:\u002F\u002F protocol (Note: http:\u002F\u002F support will be removed in the\nnear future), have a limit of 3 max redirects, and a file size limit of 1GB. In addition,\nURLs must be publicly accessible, in cases where cookie authentication or logging\nin to access the file is required, the login page HTML will be downloaded instead of the file.","properties":{"filename":{"description":"Filename, e.g. \"foo.jpg\"","type":"string"},"url":{"description":"url, e.g. \"https:\u002F\u002Fv5.airtableusercontent.com\u002Ffoo\".\n\nURLs returned will expire 2 hours after being returned from our API.\nIf you want to persist the attachments, we recommend downloading them instead of saving the URL.\nSee [our support article](https:\u002F\u002Fsupport.airtable.com\u002Fdocs\u002Fairtable-attachment-url-behavior)\nfor more information.","type":"string"}},"required":["url"],"type":"object"},{"properties":{"id":{"description":"When writing an attachment object, be sure to include all existing attachment objects\nby providing an `id`. This can be retrieved using the [get record endpoint](\u002Fapi\u002Fget-record).\n\nTo remove attachments, include the existing array of attachment objects,\nexcluding any that you wish to remove.","type":"string"}},"required":["id"],"type":"object"}]},"type":"array"},"writeFieldConfigExample":{"not":{}}},"required":["cellValueExample","fieldConfigExample","writeCellValueExample"],"type":"object"},"percentNumber":{"properties":{"cellValueExample":{"type":"number"},"cellValueV2Example":{"not":{}},"fieldConfigExample":{"properties":{"options":{"properties":{"precision":{"description":"Indicates the number of digits shown to the right of the decimal point for this field. (0-8 inclusive)","type":"number"}},"required":["precision"],"type":"object"},"type":{"const":"percent","type":"string"}},"required":["type","options"],"type":"object"},"writeCellValueExample":{"not":{}},"writeFieldConfigExample":{"not":{}}},"required":["cellValueExample","fieldConfigExample"],"type":"object"},"phone":{"properties":{"cellValueExample":{"type":"string"},"cellValueV2Example":{"not":{}},"fieldConfigExample":{"properties":{"type":{"const":"phoneNumber","type":"string"}},"required":["type"],"type":"object"},"writeCellValueExample":{"not":{}},"writeFieldConfigExample":{"not":{}}},"required":["cellValueExample","fieldConfigExample"],"type":"object"},"rating":{"properties":{"cellValueExample":{"type":"number"},"cellValueV2Example":{"not":{}},"fieldConfigExample":{"description":"Bases on a free or plus plan are limited to using the 'star' icon and 'yellowBright' color.","properties":{"options":{"properties":{"color":{"description":"The color of selected icons.","enum":["yellowBright","orangeBright","redBright","pinkBright","purpleBright","blueBright","cyanBright","tealBright","greenBright","grayBright"],"type":"string"},"icon":{"description":"The icon name used to display the rating.","enum":["star","heart","thumbsUp","flag","dot"],"type":"string"},"max":{"description":"The maximum value for the rating, from 1 to 10 inclusive.","type":"number"}},"required":["color","icon","max"],"type":"object"},"type":{"const":"rating","type":"string"}},"required":["type","options"],"type":"object"},"writeCellValueExample":{"not":{}},"writeFieldConfigExample":{"not":{}}},"required":["cellValueExample","fieldConfigExample"],"type":"object"},"richText":{"properties":{"cellValueExample":{"type":"string"},"cellValueV2Example":{"not":{}},"fieldConfigExample":{"properties":{"type":{"const":"richText","type":"string"}},"required":["type"],"type":"object"},"writeCellValueExample":{"not":{}},"writeFieldConfigExample":{"not":{}}},"required":["cellValueExample","fieldConfigExample"],"type":"object"},"rollup":{"properties":{"cellValueExample":{"anyOf":[{"type":"string"},{"type":"number"},{"const":true,"type":"boolean"}]},"cellValueV2Example":{},"fieldConfigExample":{"properties":{"options":{"properties":{"fieldIdInLinkedTable":{"description":"The id of the field in the linked table","type":"string"},"isValid":{"type":"boolean"},"recordLinkFieldId":{"description":"The linked field id","type":"string"},"referencedFieldIds":{"description":"The ids of any fields referenced in the rollup formula","items":{"type":"string"},"type":"array"},"result":{"anyOf":[{"$ref":"#\u002Fcomponents\u002Fschemas\u002FField-type-and-options"},{"type":"null"}],"description":"The resulting field type and options for the rollup. See other field\ntype configs on this page for the possible values. Can be null if invalid."}},"type":"object"},"type":{"const":"rollup","type":"string"}},"required":["type","options"],"type":"object"},"writeCellValueExample":{"not":{}},"writeFieldConfigExample":{"not":{}}},"required":["cellValueExample","fieldConfigExample","cellValueV2Example"],"type":"object"},"select":{"properties":{"cellValueExample":{"type":"string"},"cellValueV2Example":{"properties":{"color":{"description":"Optional when the select field is configured to not use colors.\n\nAllowed values: \"blueLight2\", \"cyanLight2\", \"tealLight2\", \"greenLight2\", \"yellowLight2\", \"orangeLight2\", \"redLight2\", \"pinkLight2\", \"purpleLight2\", \"grayLight2\", \"blueLight1\", \"cyanLight1\", \"tealLight1\", \"greenLight1\", \"yellowLight1\", \"orangeLight1\", \"redLight1\", \"pinkLight1\", \"purpleLight1\", \"grayLight1\", \"blueBright\", \"cyanBright\", \"tealBright\", \"greenBright\", \"yellowBright\", \"orangeBright\", \"redBright\", \"pinkBright\", \"purpleBright\", \"grayBright\", \"blueDark1\", \"cyanDark1\", \"tealDark1\", \"greenDark1\", \"yellowDark1\", \"orangeDark1\", \"redDark1\", \"pinkDark1\", \"purpleDark1\", \"grayDark1\"","type":"string"},"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"type":"object"},"fieldConfigExample":{"properties":{"options":{"properties":{"choices":{"items":{"properties":{"color":{"description":"Optional when the select field is configured to not use colors.\n\nAllowed values: \"blueLight2\", \"cyanLight2\", \"tealLight2\", \"greenLight2\", \"yellowLight2\", \"orangeLight2\", \"redLight2\", \"pinkLight2\", \"purpleLight2\", \"grayLight2\", \"blueLight1\", \"cyanLight1\", \"tealLight1\", \"greenLight1\", \"yellowLight1\", \"orangeLight1\", \"redLight1\", \"pinkLight1\", \"purpleLight1\", \"grayLight1\", \"blueBright\", \"cyanBright\", \"tealBright\", \"greenBright\", \"yellowBright\", \"orangeBright\", \"redBright\", \"pinkBright\", \"purpleBright\", \"grayBright\", \"blueDark1\", \"cyanDark1\", \"tealDark1\", \"greenDark1\", \"yellowDark1\", \"orangeDark1\", \"redDark1\", \"pinkDark1\", \"purpleDark1\", \"grayDark1\"","type":"string"},"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"type":"object"},"type":"array"}},"required":["choices"],"type":"object"},"type":{"const":"singleSelect","type":"string"}},"required":["options","type"],"type":"object"},"writeCellValueExample":{"not":{}},"writeFieldConfigExample":{"properties":{"options":{"properties":{"choices":{"items":{"properties":{"color":{"description":"Optional when creating an option.","type":"string"},"id":{"description":"This is not specified when creating new options, useful when specifing existing\noptions (for example: reordering options, keeping old options and adding new ones, etc)","type":"string"},"name":{"type":"string"}},"required":["name"],"type":"object"},"type":"array"}},"required":["choices"],"type":"object"},"type":{"const":"singleSelect","type":"string"}},"required":["options","type"],"type":"object"}},"required":["cellValueExample","fieldConfigExample","cellValueV2Example","writeFieldConfigExample"],"type":"object"},"simpleText":{"properties":{"cellValueExample":{"type":"string"},"cellValueV2Example":{"not":{}},"fieldConfigExample":{"properties":{"type":{"const":"singleLineText","type":"string"}},"required":["type"],"type":"object"},"writeCellValueExample":{"not":{}},"writeFieldConfigExample":{"not":{}}},"required":["cellValueExample","fieldConfigExample"],"type":"object"},"syncSource":{"properties":{"cellValueExample":{"description":"The sync source name.","type":"string"},"cellValueV2Example":{"properties":{"color":{"type":"string"},"id":{"description":"The id unique for this source within this base. **Not** the baseId.","type":"string"},"name":{"description":"The sync source name.","type":"string"}},"required":["id","name"],"type":"object"},"fieldConfigExample":{"properties":{"options":{"properties":{"choices":{"items":{"properties":{"color":{"description":"Optional when the select field is configured to not use colors.\n\nAllowed values: \"blueLight2\", \"cyanLight2\", \"tealLight2\", \"greenLight2\", \"yellowLight2\", \"orangeLight2\", \"redLight2\", \"pinkLight2\", \"purpleLight2\", \"grayLight2\", \"blueLight1\", \"cyanLight1\", \"tealLight1\", \"greenLight1\", \"yellowLight1\", \"orangeLight1\", \"redLight1\", \"pinkLight1\", \"purpleLight1\", \"grayLight1\", \"blueBright\", \"cyanBright\", \"tealBright\", \"greenBright\", \"yellowBright\", \"orangeBright\", \"redBright\", \"pinkBright\", \"purpleBright\", \"grayBright\", \"blueDark1\", \"cyanDark1\", \"tealDark1\", \"greenDark1\", \"yellowDark1\", \"orangeDark1\", \"redDark1\", \"pinkDark1\", \"purpleDark1\", \"grayDark1\"","type":"string"},"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"type":"object"},"type":"array"}},"required":["choices"],"type":"object"},"type":{"const":"externalSyncSource","type":"string"}},"required":["type","options"],"type":"object"},"writeCellValueExample":{"not":{}},"writeFieldConfigExample":{"not":{}}},"required":["cellValueExample","fieldConfigExample","cellValueV2Example"],"type":"object"},"urlText":{"properties":{"cellValueExample":{"type":"string"},"cellValueV2Example":{"not":{}},"fieldConfigExample":{"properties":{"type":{"const":"url","type":"string"}},"required":["type"],"type":"object"},"writeCellValueExample":{"not":{}},"writeFieldConfigExample":{"not":{}}},"required":["cellValueExample","fieldConfigExample"],"type":"object"}},"required":["autoNumber","aiText","barcode","button","checkbox","collaborator","createdBy","lastModifiedBy","syncSource","count","dateOnly","dateAndTime","foreignKey","formula","createdTime","lastModifiedTime","lookup","multiCollaborator","multiSelect","multilineText","multipleAttachment","decimalOrIntegerNumber","currencyNumber","durationNumber","percentNumber","phone","rating","richText","rollup","select","urlText","emailText","simpleText"],"type":"object"}}},"apiDocsType":"web","airtableApiEndpointUrl":"https:\u002F\u002Fapi.airtable.com","enabledEnterpriseFeatureNames":[],"enterpriseAccountIds":null}</script></head><body class="flex baymax absolute all-0"><div class="fixed bottom-0 left-0 right-0 p1 z4 big"><div class="max-width-1 mx-auto yellow text-dark rounded p2"><h3 class="strong mb1">Your browser version is not supported. Try our <a href="https://www.airtable.com/downloads" class="understroke link">desktop apps</a>!</h3>Alternatively, use the latest version of <a href="https://www.google.com/intl/en/chrome/browser/" class="understroke link" target="_blank" rel="noopener noreferrer">Chrome</a>, <a href="http://www.mozilla.org/en-US/" class="understroke link" target="_blank" rel="noopener noreferrer">Firefox</a>, Safari, or Edge instead.</div></div><div id="ssrInnerContainer" style="height:100%;width:100%"><link href="https://fonts.googleapis.com/css?family=Space+Mono:400,400i,700,700i&display=swap" rel="stylesheet"/><div id="developersApp"></div></div><script src="//static.airtable.com/polyfills/455a1bf3.js" nonce="KGonNqmdinEb" crossorigin="anonymous"></script><script src="//static.airtable.com/js/lib/babel-polyfill.min.js" nonce="KGonNqmdinEb" crossorigin="anonymous"></script><script src="//static.airtable.com/js/lib/jquery/2.1.4/jquery-mod1.min.js" nonce="KGonNqmdinEb" crossorigin="anonymous"></script><script src="https://static.airtable.com/esbuild/by_sha/e5008d8b/gz/client/developers/run_developers_rest_api.js" nonce="KGonNqmdinEb" crossorigin="anonymous" type="module"></script><script nonce="KGonNqmdinEb"> (function () { var beaconUrl = 'https://airtable.com/internal/page_view?isInitialPageLoad=true&pageLoadId=pglR7C3H8yXbrdMuz'; var _location = window.location; var referrer = document.referrer; beaconUrl += '&location=' + encodeURIComponent(_location); if (referrer) { beaconUrl += '&referrer=' + encodeURIComponent(referrer); } var img = document.createElement('img'); img.src = beaconUrl; img.style.display = 'none'; img.height = '1'; img.width = '1'; document.body.appendChild(img); })(); </script><img height="1" width="1" style="display:none" role="none" alt="" src="https://analytics.twitter.com/i/adsct?txn_id=l6gpl&p_id=Twitter&tw_sale_amount=0&tw_order_quantity=0"/><div id="munchkinWidget" style="display:none;position:fixed;height:1px;width:1px;background:transparent;overflow:hidden;opacity:0;pointer-events:none"><iframe sandbox="allow-scripts allow-same-origin" referrerPolicy="no-referrer" data-src="https://static.airtable.com/html/marketo_widget.html" style="width:100%;height:100%;margin:0;padding:0;border:0;background:transparent;overflow:hidden" class="optanon-category-C0002"></iframe><script type="text/javascript" nonce="KGonNqmdinEb"> (function() { const marketoWidget = document.querySelector('#' + "munchkinWidget"); const marketoWidgetFrame = marketoWidget.querySelector('iframe'); marketoWidgetFrame.onload = function() { const widgetFrameWindow = marketoWidgetFrame.contentWindow; const widgetStyle = marketoWidget.style; // Send Marketo settings to the page so it will initialize itself. widgetFrameWindow.postMessage({ kind: 'init', data: { munchkinId: "458-JHQ-131", munchkinSettings: {"apiOnly":true,"useBeaconAPI":true,"asyncOnly":true,"anonymizeIP":true}, url: document.location.pathname, params: document.location.search }, }, "https:\u002F\u002Fstatic.airtable.com"); }; })(); </script></div><script type="text/javascript" nonce="KGonNqmdinEb"> window.googleDataLayer = window.googleDataLayer || []; window.googleDataLayer.push({'is_logged_in': false}); (function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= 'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f); })(window,document,'script','googleDataLayer','GTM-NCLXNTS'); </script><script nonce="KGonNqmdinEb"> var cookieSettingsButton = document.getElementById('cookieBannerSettingsButton'); if (cookieSettingsButton != null && window.Optanon != undefined) { cookieSettingsButton.style.display = 'inline-block'; cookieSettingsButton.addEventListener('click', window.Optanon.ToggleInfoDisplay); } </script></body></html>