- 23 Aug 2023
- 2 Minutes to read
Getting started with Airtable's Web API
- Updated on 23 Aug 2023
- 2 Minutes to read
You can access the documentation for the Web API here, or directly from your base by clicking on the Help button in the upper right-hand corner while you are logged in on a laptop or desktop. This will bring up a list of additional resources. You will find a link to the API documentation at the bottom of that list.
|Plan availability||All plan types with varying call limitations|
|Platform(s)||Web/Browser, Mac app, and Windows app|
API record limits
When you list records with Airtable's API, you won't necessarily get all of them at once. Instead, you will receive them in pages of up to 100 records at a time. As soon as a table has more than 100 records, you will need to make multiple requests, one per page.
For example, if your table has 501 records, the results will be spread across 6 pages, and therefore 6 HTTP requests are needed to fully capture all of that table's records. Your first request might look something like this with your base's app id
appxxx and the table name:
You will get the first page of records (under the "records" key), but if there is another page, you'll also get an "offset" that would look something like this:
To fetch the next page (in other words, the next 100 records), you'll include that offset as a query parameter. For example:
This will give you the records from the next page. If there's another page, you'll repeat the process—grab the offset and put it in the offset query parameter. When the response doesn't include an offset anymore, you know you've reached the last page and can stop.
pageSizeparameter to change the number from 100 to a smaller number like 50, but 100 is the maximum and most users do not change this.
Consult the Web API Scopes documentation where you'll find a list of the various Web API endpoints and how each one functions.
We recommend that you start with the Web API introduction here.
Yes, the Web API has a rate limit of 5 requests per second, per base. This limit is the same across all pricing tiers and increased rate limits are not currently available. For more information, see the "Rate Limits" section of the API documentation.
Yes. These vary by plan type:
- Free plan - 1000 calls per workspace per month
- Team plan - 100,000 calls per workspace per month
- Business and Enterprise plans - Unlimited API calls (Still subject to other limits such as the rate limits discussed above)
Returned records do not include any fields with "empty" values, e.g.
false. If you need to get the names of all fields in your table, you can create one record with all fields populated, and make a request to fetch that record.