Airtable Enterprise API
  • 15 Nov 2022
  • 2 Minutes to read
  • Dark
    Light

Airtable Enterprise API

  • Dark
    Light

Airtable’s Enterprise API documentation can be accessed when logged into an Airtable account connected to an Enterprise workspace. The article below is a brief overview of Airtable’s API as it specifically relates to our Enterprise customers.


Overview

If you or your team have development experience, then using our API can help to perform certain programmatic or bulk actions that would otherwise take tedious, repetitive, and/or manual effort to perform. In order to access and use the Enterprise API you will need:

The Airtable Enterprise API uses key-based (token) authentication like Airtable's Web API. All requests should send the API key in the Authorization header. When logged into an Enterprise account, the Enterprise-related documentation is tagged with a purple "Enterprise" icon:

Additionally, all requests to these endpoints must be made on the server-side. Client-side requests are not allowed because they would expose the user's API key.

WARNING

Do not share your API key with anyone (including anyone at Airtable) since it's effectively a password that allows access to all your bases. If you accidentally reveal your API key, you should regenerate your API key as soon as possible at https://airtable.com/account


Using the Airtable Enterprise API

Airtable’s Admin Panel provides an interface for reviewing users, bases, and workspaces, as well as setting enterprise-wide security settings. The Enterprise API allows teams to manage their account programmatically outside of the Admin panel UI through actions like managing users, updating access permissions, and managing bases, tables, and views.

Occasionally, some teams may want to add their own metadata on top of the information pulled by an API request such as department information, managers, or billing units. This allows them to more effectively organize their enterprise resources and take action when necessary.

Airtable’s scripting extension and run a script automation action allow developers to write JavaScript code embedded within their custom application. Using this alongside the Enterprise API means developers can carry out a range of programmatic functions. Example use cases are covered in the next section below.


Example use cases

The API endpoints discussed below represent just some of the ways that our API can be used from an administrative/IT perspective. 

Security and User management

Base and Workspace management

Note

Most of the methods described above are only available to users with Enterprise admin permissions


FAQs

I'm an Enterprise user, but I'm unable to access the Enterprise API -- what's causing this?

Your organization may have an FLA (Flexible License Agreement) with Airtable, which means that only certain workspaces are upgraded to Enterprise, while others remain on our self-serve plans (Free, Plus, and Pro). It's only possible to use the Enterprise API in Enterprise-enabled workspaces (and the bases contained in them) at this time.


Was this article helpful?