# Airtable Web API

> REST API reference and guides for airtable.com — agent-readable markdown.

## API reference
- [Introduction](https://airtable.com/developers/web/api/introduction.md): Overview of the Airtable REST API
- [Authentication](https://airtable.com/developers/web/api/authentication.md): Authenticate via personal access tokens or OAuth
- [Scopes](https://airtable.com/developers/web/api/scopes.md): Token scope definitions and permissions
- [OAuth reference](https://airtable.com/developers/web/api/oauth-reference.md): How to request OAuth access tokens for an integration
- [Errors](https://airtable.com/developers/web/api/errors.md): Error codes and how to handle them
- [Rate limits](https://airtable.com/developers/web/api/rate-limits.md): API rate limits and throttling behavior
- [Billing plans](https://airtable.com/developers/web/api/billing-plans.md): Endpoint availability by billing plan
- [Changelog](https://airtable.com/developers/web/api/changelog.md): Changes to the Web API and its documentation
- [Get user info](https://airtable.com/developers/web/api/get-user-id-scopes.md): Get the authenticated user's ID and token scopes
- [Create records](https://airtable.com/developers/web/api/create-records.md): Create multiple records in a table
- [Delete multiple records](https://airtable.com/developers/web/api/delete-multiple-records.md): Delete records by an array of record IDs
- [Delete record](https://airtable.com/developers/web/api/delete-record.md): Delete a single record
- [Get record](https://airtable.com/developers/web/api/get-record.md): Get a single record
- [List records](https://airtable.com/developers/web/api/list-records.md): List records in a table
- [Sync CSV data](https://airtable.com/developers/web/api/post-sync-api-endpoint.md): Sync raw CSV data into a Sync API table
- [Update multiple records](https://airtable.com/developers/web/api/update-multiple-records.md): Update or upsert multiple records
- [Update record](https://airtable.com/developers/web/api/update-record.md): Update a single record
- [Upload attachment](https://airtable.com/developers/web/api/upload-attachment.md): Upload a file to an attachment cell
- [Field types and cell values](https://airtable.com/developers/web/api/field-model.md): Supported field types and their cell value formats
- [Create field](https://airtable.com/developers/web/api/create-field.md): Create a field and return its schema
- [Update field](https://airtable.com/developers/web/api/update-field.md): Update a field's name, description, or options
- [Create comment](https://airtable.com/developers/web/api/create-comment.md): Create a comment on a record
- [Delete comment](https://airtable.com/developers/web/api/delete-comment.md): Delete a comment from a record
- [List comments](https://airtable.com/developers/web/api/list-comments.md): List comments on a record, newest first
- [Update comment](https://airtable.com/developers/web/api/update-comment.md): Update a comment on a record
- [Create table](https://airtable.com/developers/web/api/create-table.md): Create a table and return its schema
- [Update table](https://airtable.com/developers/web/api/update-table.md): Update a table's name, description, or date dependency settings
- [Create base](https://airtable.com/developers/web/api/create-base.md): Create a base with tables and return its schema
- [Get base collaborators](https://airtable.com/developers/web/api/get-base-collaborators.md): List collaborators and their permission levels on a base
- [Get base schema](https://airtable.com/developers/web/api/get-base-schema.md): Return the schema of all tables in a base
- [List bases](https://airtable.com/developers/web/api/list-bases.md): List bases the token can access
- [Webhooks overview](https://airtable.com/developers/web/api/webhooks-overview.md): Real-time notifications when base data changes
- [Create a webhook](https://airtable.com/developers/web/api/create-a-webhook.md): Create a webhook on a base
- [Delete a webhook](https://airtable.com/developers/web/api/delete-a-webhook.md): Delete a webhook
- [Enable/disable webhook notifications](https://airtable.com/developers/web/api/enable-disable-webhook-notifications.md): Enable or disable notification pings for a webhook
- [List webhook payloads](https://airtable.com/developers/web/api/list-webhook-payloads.md): Retrieve queued update payloads for a webhook
- [List webhooks](https://airtable.com/developers/web/api/list-webhooks.md): List all webhooks on a base with their statuses
- [Refresh a webhook](https://airtable.com/developers/web/api/refresh-a-webhook.md): Extend a webhook's expiration
- [Delete view](https://airtable.com/developers/web/api/delete-view.md): Delete a view
- [Get view metadata](https://airtable.com/developers/web/api/get-view-metadata.md): Get metadata for a view
- [List views](https://airtable.com/developers/web/api/list-views.md): List views in a base
- [Add base collaborator](https://airtable.com/developers/web/api/add-base-collaborator.md): Add a collaborator to a base
- [Add interface collaborator](https://airtable.com/developers/web/api/add-interface-collaborator.md): Add a collaborator to an interface
- [Add workspace collaborator](https://airtable.com/developers/web/api/add-workspace-collaborator.md): Add a collaborator to a workspace
- [Delete base collaborator](https://airtable.com/developers/web/api/delete-base-collaborator.md): Remove a collaborator from a base
- [Delete interface collaborator](https://airtable.com/developers/web/api/delete-interface-collaborator.md): Remove a collaborator from an interface
- [Delete workspace collaborator](https://airtable.com/developers/web/api/delete-workspace-collaborator.md): Remove a collaborator from a workspace
- [Get interface](https://airtable.com/developers/web/api/get-interface.md): Get metadata for an interface
- [Get workspace collaborators](https://airtable.com/developers/web/api/get-workspace-collaborators.md): List collaborators and their permission levels on a workspace
- [Update collaborator base permission](https://airtable.com/developers/web/api/update-collaborator-base-permission.md): Update a collaborator's permission level on a base
- [Update interface collaborator](https://airtable.com/developers/web/api/update-interface-collaborator.md): Update permissions for an interface collaborator
- [Update workspace collaborator](https://airtable.com/developers/web/api/update-workspace-collaborator.md): Update a collaborator's permission level on a workspace
- [Delete base invite](https://airtable.com/developers/web/api/delete-base-invite.md): Delete a base invite
- [Delete interface invite](https://airtable.com/developers/web/api/delete-interface-invite.md): Delete an interface invite
- [Delete workspace invite](https://airtable.com/developers/web/api/delete-workspace-invite.md): Delete a workspace invite
- [Delete share](https://airtable.com/developers/web/api/delete-share.md): Permanently delete a share (not recoverable)
- [List shares](https://airtable.com/developers/web/api/list-shares.md): List shares on a base
- [Manage share](https://airtable.com/developers/web/api/manage-share.md): Enable, disable, or update a share
- [Create workspace](https://airtable.com/developers/web/api/create-workspace.md): Create a workspace in an enterprise account
- [Delete base](https://airtable.com/developers/web/api/delete-base.md): Delete a base
- [Delete workspace](https://airtable.com/developers/web/api/delete-workspace.md): Delete a workspace
- [Move base](https://airtable.com/developers/web/api/move-base.md): Move a base between workspaces in an enterprise
- [Move workspaces](https://airtable.com/developers/web/api/move-workspaces.md): Batch move workspaces between enterprise accounts in the same organization
- [Update workspace restrictions](https://airtable.com/developers/web/api/update-workspace-restrictions.md): Update sharing-restriction settings for a workspace
- [Create descendant enterprise](https://airtable.com/developers/web/api/create-descendant-enterprise.md): Create a child enterprise account
- [Get enterprise](https://airtable.com/developers/web/api/get-enterprise.md): Get metadata for an enterprise account
- [Remove user from enterprise](https://airtable.com/developers/web/api/remove-user-from-enterprise.md): Remove a user from all enterprise workspaces, bases, interfaces, and groups
- [Delete records from a HyperDB table by primary keys](https://airtable.com/developers/web/api/hyperdb-delete-records-by-primary-keys.md): Delete HyperDB records by primary key
- [Read records from a HyperDB table](https://airtable.com/developers/web/api/hyperdb-table-read-records.md): Read records from a HyperDB table
- [Update or insert records from a HyperDB table by primary keys](https://airtable.com/developers/web/api/hyperdb-upsert-records-by-primary-keys.md): Upsert HyperDB records by primary key
- [Delete user by id](https://airtable.com/developers/web/api/delete-user-by-id.md): Delete an enterprise user by ID
- [Delete users by email](https://airtable.com/developers/web/api/delete-users-by-email.md): Batch delete enterprise users by email
- [Get user by id](https://airtable.com/developers/web/api/get-user-by-id.md): Get an enterprise user by ID
- [Get users by id or email](https://airtable.com/developers/web/api/get-users-by-id-or-email.md): Batch get enterprise users by ID or email
- [Grant admin access](https://airtable.com/developers/web/api/grant-admin-access.md): Grant admin access to enterprise users
- [Logout user](https://airtable.com/developers/web/api/logout-user.md): Log out an enterprise user
- [Manage user](https://airtable.com/developers/web/api/manage-user.md): Manage a user in an enterprise account
- [Manage user batched](https://airtable.com/developers/web/api/manage-user-batched.md): Batch manage enterprise users
- [Manage user membership](https://airtable.com/developers/web/api/manage-user-membership.md): Batch manage enterprise organization memberships
- [Revoke admin access](https://airtable.com/developers/web/api/revoke-admin-access.md): Revoke admin access from enterprise users
- [Get user group](https://airtable.com/developers/web/api/get-user-group.md): Get metadata for a user group
- [Move user groups](https://airtable.com/developers/web/api/move-user-groups.md): Batch move user groups between enterprise accounts in the same organization
- [Audit log overview](https://airtable.com/developers/web/api/audit-logs-overview.md): Monitor audit log events in your organization
- [Audit log integration guide](https://airtable.com/developers/web/api/audit-logs-integration-guide.md): Getting started with the Audit Log API
- [Audit log event types](https://airtable.com/developers/web/api/audit-log-event-types.md): Supported audit log event types and their payload formats
- [Audit log events](https://airtable.com/developers/web/api/audit-log-events.md): Retrieve audit log events for an enterprise
- [Change events](https://airtable.com/developers/web/api/change-events.md): Retrieve change events for enterprise bases
- [Create eDiscovery export](https://airtable.com/developers/web/api/create-ediscovery-export.md): Create an eDiscovery export request
- [Get eDiscovery export](https://airtable.com/developers/web/api/get-ediscovery-export.md): Get the status and result of an eDiscovery export
- [List eDiscovery exports](https://airtable.com/developers/web/api/list-ediscovery-export.md): List all eDiscovery exports and their statuses
- [Delete block installation](https://airtable.com/developers/web/api/delete-block-installation.md): Delete a block installation (recoverable)
- [List block installations](https://airtable.com/developers/web/api/list-block-installations.md): List block installations in a base
- [Manage block installation](https://airtable.com/developers/web/api/manage-block-installation.md): Enable, disable, or update a block installation
- [SCIM overview](https://airtable.com/developers/web/api/scim-overview.md): Provision and manage users and groups via SCIM 2.0
- [Create group](https://airtable.com/developers/web/api/create-scim-group.md): Create a SCIM group
- [Create user](https://airtable.com/developers/web/api/create-scim-user.md): Create a SCIM user
- [Delete group](https://airtable.com/developers/web/api/delete-scim-group.md): Delete a SCIM group
- [Delete user](https://airtable.com/developers/web/api/delete-scim-user.md): Delete a SCIM user
- [Get group](https://airtable.com/developers/web/api/get-scim-group.md): Get a SCIM group
- [Get user](https://airtable.com/developers/web/api/get-scim-user.md): Get a SCIM user
- [List groups](https://airtable.com/developers/web/api/list-scim-groups.md): List SCIM groups
- [List users](https://airtable.com/developers/web/api/list-scim-users.md): List SCIM users
- [Patch group](https://airtable.com/developers/web/api/patch-scim-group.md): Apply SCIM patch operations to a group
- [Patch user](https://airtable.com/developers/web/api/patch-scim-user.md): Apply SCIM patch operations to a user
- [Put group](https://airtable.com/developers/web/api/put-scim-group.md): Replace all attributes of a SCIM group
- [Put user](https://airtable.com/developers/web/api/put-scim-user.md): Replace all attributes of a SCIM user
- [Org management glossary](https://airtable.com/developers/web/api/org-management-glossary.md): Glossary of terms for org management endpoints

## Guides
- [Introduction](https://airtable.com/developers/web/guides/introduction.md): Overview of Airtable API guides
- [Personal access tokens](https://airtable.com/developers/web/guides/personal-access-tokens.md): Create and manage tokens for personal API integrations
- [OAuth integrations](https://airtable.com/developers/web/guides/oauth-integrations.md): Register an OAuth integration so users can grant API access
- [Webhooks API](https://airtable.com/developers/web/guides/webhooks-api.md): Subscribe to real-time base change notifications

## Optional

### Models
- [Application Permission Levels](https://airtable.com/developers/web/api/model/application-permission-levels.md): Permission levels available on a base or interface
- [Audit log](https://airtable.com/developers/web/api/model/audit-log.md): A single "audit log task"
- [Audit log actor](https://airtable.com/developers/web/api/model/audit-log-actor.md): The user, app, or system that initiated an audit log event
- [Base group collaborator](https://airtable.com/developers/web/api/model/base-group-collaborator.md): A user group with collaborator access to a base
- [Base individual collaborator](https://airtable.com/developers/web/api/model/base-individual-collaborator.md): A single user with collaborator access to a base
- [Base invite link](https://airtable.com/developers/web/api/model/base-invite-link.md): An invite link granting new collaborators access to a base
- [Change events actor](https://airtable.com/developers/web/api/model/change-events-actor.md): The user, app, or system that produced a change event
- [Change events data](https://airtable.com/developers/web/api/model/change-events-data.md): Per-table change payload for a change event; created/destroyed/changed fields are populated based on what actually changed
- [Change events table change](https://airtable.com/developers/web/api/model/change-events-table-change.md): Table change data that is unique to change events
- [Change events table create](https://airtable.com/developers/web/api/model/change-events-table-create.md): Table creation data that is unique to change events
- [Collaborations](https://airtable.com/developers/web/api/model/collaborations.md): Direct collaborations on the enterprise account's workspaces, bases and interfaces
- [Date Dependency Metadata](https://airtable.com/developers/web/api/model/date-dependency-metadata.md): Dependency metadata for a linked record
- [Date Dependency Settings](https://airtable.com/developers/web/api/model/date-dependency-settings.md): Configuration for a table's date dependency settings
- [Field Type](https://airtable.com/developers/web/api/model/field-type.md): All valid field type identifiers
- [Group Collaborator](https://airtable.com/developers/web/api/model/group-collaborator.md): A user group collaborating on a workspace, base, or interface
- [Individual Collaborator](https://airtable.com/developers/web/api/model/individual-collaborator.md): A single user collaborating on a workspace, base, or interface
- [Invite link](https://airtable.com/developers/web/api/model/invite-link.md): Represents a single or multiuse invite link
- [SCIM user schema](https://airtable.com/developers/web/api/model/scim-user-schema.md): SCIM User schema definition (RFC 7643) used by Airtable's SCIM endpoints
- [Table Config](https://airtable.com/developers/web/api/model/table-config.md): Configuration shape for a table when creating or updating bases
- [Table model](https://airtable.com/developers/web/api/model/table-model.md): Schema representation of a table, including its fields and views
- [Timezone](https://airtable.com/developers/web/api/model/timezone.md): IANA timezone identifiers
- [User mentioned](https://airtable.com/developers/web/api/model/user-mentioned.md): The user, user group, or app agent mentioned and returned from the comments API
- [Webhooks action](https://airtable.com/developers/web/api/model/webhooks-action.md): The action that triggered a webhook payload (user, app, or system source)
- [Webhooks changed record](https://airtable.com/developers/web/api/model/webhooks-changed-record.md): One or multiple records being changed and reported upon via webhooks
- [Webhooks created record](https://airtable.com/developers/web/api/model/webhooks-created-record.md): One or multiple records being created and reported upon via webhooks
- [Webhooks notification](https://airtable.com/developers/web/api/model/webhooks-notification.md): Metadata about the most recent webhook ping and its success status
- [Webhooks payload](https://airtable.com/developers/web/api/model/webhooks-payload.md): Webhook payload contents, varying by specification and action
- [Webhooks specification](https://airtable.com/developers/web/api/model/webhooks-specification.md): A single webhook may watch changes in a table, view, or base
- [Webhooks table changed](https://airtable.com/developers/web/api/model/webhooks-table-changed.md): Per-table change record in a webhook payload; created/destroyed/changed fields are populated based on the specification's filters
- [Webhooks table created](https://airtable.com/developers/web/api/model/webhooks-table-created.md): Snapshot of a newly created table in a webhook payload, including metadata, fields, and seeded records
- [Webhooks user](https://airtable.com/developers/web/api/model/webhooks-user.md): A user referenced in a webhook payload
- [Workspace Permission Levels](https://airtable.com/developers/web/api/model/workspace-permission-levels.md): Permission levels available on a workspace

## See also
- [Data Extensions SDK](https://airtable.com/developers/extensions/llms.txt): SDK for building custom apps that run inside Airtable bases
- [Interface Extensions SDK](https://airtable.com/developers/interface-extensions/llms.txt): SDK for building extensions in Airtable Interface Designer
- [Scripting](https://airtable.com/developers/scripting/llms.txt): Scripts and automations API for Airtable bases — cursor, fields, records, tables, views, plus examples