The permission level of the user for the base.

Bases

A date timestamp in the ISO format, eg:"2018-01-01T00:00:00.000Z"

Cell values are keyed by either field name or field ID (conditioned on returnFieldsByFieldId). See Cell Values for more information on cell value response types.

Output schema

Records

The first column in the table and every view

Tables

Base ID

Airtable

List groups as SCIM Groups objects. SCIM specification for list responses.

List Groups

Create a new group from a SCIM Group object. This endpoint creates a group with no members. Use the patch group or put group endpoints to populate the new group with members.

Create a new group

Delete a group. This endpoint will delete a group even if it has members. However, it will not delete any users that are members of the group.

Delete a single SCIM Group

Get a single group as a SCIM Group object.

Get a single group

Applies a list of SCIM patch operations to a Group sequentially.

SCIM patch an array of operations to a Group

Replace a Group's attributes with all new values.

Replace a Group's attributes with all new values

List users as SCIM User objects. See the SCIM specification for list responses for more.

List Users

Create a new user from a SCIM User object. The response is the SCIM user object representing the newly created user. On creation, the user will always be marked active, and the emails array will include a single entry that matches the username. See the SCIM User schema for details.

WARNING: As the user is provisioned without a password, the use of this endpoint is only intended on environments with SSO Active.

WARNING: If your enterprise is not capturing the user's email domain, it is possible this will fail with a conflict against an already created user that is not a member of your enterprise (and this not visible when listing users). If this occurs, it is recommended you add the user to your enterprise (e.g. add them to a workspace and then claim them).

Create a new user

The endpoint cannot be used to delete the admin that owns the authentication token used to make the request or the sole owner of a workspace that has multiple collaborators.

Delete a single SCIM user

Get a single user

Perform a list of SCIM patch operations in sequence on an existing user. See SCIM specification for more.

Perform a list of SCIM patch operations on an existing user

Replace a user's attributes with all new values. The body parameters are the same as those for creating a user, except that you can set active to true or false.

Replace a user's attributes with all new values.

Lists all webhooks that are registered for a base, along with their statuses.

List Webhooks

Creates a new webhook in the specified base. Payloads may be generated and the notification URL (if given) will get a ping shortly after this completes.

Create a Webhook

Deletes a webhook. Creator level permissions are required in order to delete a webhook.

Deletes a webhook

Enables or disables notification pings for a webhook. Creator level permissions are required.

Enable/Disable Webhook Notifications

Enumerate the update messages for a client to consume. Clients should call this after they receive a ping.

List Webhook Payloads

Extend the life of a webhook. The new expiration time will be 7 days after the refresh time. Note that this endpoint only applies to active webhooks with an expiration time.

Refresh a Webhook

Returns the list of bases the API key can access in the order they appear on the user's home screen, 1000 bases at a time.

List Bases

Creates a new base with the provided tables and returns the schema for the newly created base.

Creates a new base with the provided tables

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.

Deletes the specified base

Lists basic information of base block installations.

List Block Installations

A deleted block installation is recoverable.

Delete Block Installation

Manages block installation state.

Despite the name, this route currently only supports adding one collaborator at a time.

Add a new base collaborator

Delete a base collaborator

Updates the permission level of a collaborator on a base.

Update Collaborator Base Permission

Does not include deleted collaborators and only includes outstanding invites.

Returns general information on the interface

Use this to add a collaborator to an interface.

Add a collaborator to an interface

Delete an interface collaborator. Requires base collaborator access to remove others, but can be used to remove yourself even with interface-only collaborator access.

Delete an interface collaborator

Use this to update permissions for an interface-only collaborator.

Update Interface Collaborator

Delete an interface invite

Delete a base invite. The invite must be outstanding.

Delete a base invite

Lists basic information of base shares.

WARNING: Hard deleted share is NOT recoverable!!!

Delete Share

Manages share state

Returns the schema of the tables in the specified base.

Get Base Schema

Creates a new table and returns the schema for the newly created table.

Creates a new table

Updates the name and/or description of a table. At least one of name or description must be specified.

Updates the name and/or description of a table

Creates a new column and returns the schema for the newly created column.

Create Field

Updates the name and/or description of a field. At least one of name or description must be specified.

Update Field

Lists basic information of base views

Delete a view

Get View Metadata

Returns basic information relevant to the enterprise account.

Get Enterprise Account

By default, this will walk all the data we're currently storing and continue walking data into the future.

Retrieve audit log events for an enterprise

These change events are available for 14 days from the date of the event.

Retrieve change events for enterprise bases

Allows an enterprise admin to delete multiple users by their email addresses.

Delete multiple users by email

Returns basic information relevant to both internal and external user.

Get Users by ID or Email

One of id or email must be 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.

Batch manage enterprise account users

Batch manage organizations enterprise account users. This endpoint allows you to change a user's membership status from being unmanaged to being an organization member, and vice versa.

Manage User Membership

Delete ELA enterprise account internal users and 'claiming' enterprise account managed users.

Get User by ID

Manage ELA and FLA enterprise account internal users and 'claiming' enterprise managed users.

Manage ELA and FLA enterprise account internal users

Clear user API key if there is one. Only available for ELA and FLA internal enterprise account users and managed "claiming" enterprise users.

Clear user API key

Logout the user. Only available for ELA and FLA internal enterprise account users and managed "claiming" enterprise users.

Logout the user

Regenerate user API key and return the key. Only available for ELA and FLA internal enterprise account users and managed "claiming" enterprise users.

Regenerate User API Key

Unshare a user from all enterprise workspaces, bases, and interfaces. If applicable, the user will also be removed from as an enterprise admin.

Remove User from Enterprise

Returns basic information relevant to the user group.

Get User Group

Deletes the specified workspace. Deleted workspaces can be restored by workspace owners from the Trash UI, up to the workspace's billing plan retention period. Note that if the API user is not currently a workspace owner, the workspace will not show up in the user's Trash.

Deletes the specified workspace

Returns basic information on the workspace. Does not include deleted collaborators and only include outstanding invites.

Get Workspace Collaborators

Add a new workspace collaborator

Delete Workspace Collaborator

Updates the permission level of a collaborator on a workspace.

Update Workspace Collaborator

Delete a workspace invite

Move a base between two workspaces owned by the enterprise.

Update sharing restrictions settings for the workspace.

Update Workspace Restrictions

Deletes records given an array of record ids.

Deletes multiple records

List records in a table. Note that table names and table ids can be used interchangeably. The server returns one page of records at a time.

List records in a table

Updates up to 10 records, or upserts them when performUpsert is set.

Update Multiple Records

Creates multiple records. Note that table 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.

Creates multiple records

Syncs raw CSV data into a Sync API table. The CSV data can contain up to 10k rows, 500 columns, and the HTTP request's size is limited to 2 MB. There is a rate limit of 1 request, per 10 minutes, per base for this endpoint.

Sync CSV Data

Deletes a single record

Retrieve a single record. Any 'empty' fields (e.g. '', [], or false) in the record will not be returned.

Retrieve a single record

Updates a single record with partial data. Only updates the fields provided in the request body.

Update a single record using PATCH

Updates a single record with full data. Unspecified fields will be cleared.

Update a single record using PUT

Returns a list of comments for the record from newest to oldest.

List Comments

Creates a comment on a record.

Non-admin API users can only delete comments they have created. Enterprise Admins can delete any comment from a record.

Deletes a comment from a record

API users can only update comments they have created. User mentioned is supported.

Airtable API Integration Profile

Supercharge your product integrations today