You can access the documentation for the public REST API here, or directly from your base by clicking on the "Help" button in the upper right-hand corner while you are logged in. This will bring up a list of additional resources. You will find a link to the API documentation at the bottom of that list.
What can I do with the Airtable API?
The Airtable API supports four main actions:
- Retrieve records from your Airtable base
- Create new records
- Update existing records
- Delete records
How do I get started?
Make sure you've generated an API key for your account, and then you're all set! The documentation is base-specific, so you will see example requests (specific to your own base and tables!) that you can copy, as well as example responses.
Is there a rate limit?
Yes, the public 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.
When I fetch records with the API, some of my fields are missing. Why is that?
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.
Can I get information about my base, such as the base schema, with the API?
The public API only supports fetching record data -- not information about the base itself. However, we do have a Metadata API that can be used to fetch a base's schema. You can view the metadata API documentation here, and request a developer token by completing this form.