Download the PHP package tapp/laravel-airtable without Composer

Laravel SDK for Airtable

A simple approach to interacting with Airtables.

Installation

You can install the package via composer:

Publish the config file:

Define airtables account information in .env:

• AIRTABLE_KEY Airtable is requiring personal access tokens for Authorization starting in 2024. A token can be created here: https://airtable.com/create/tokens. If you are upgrading from an API key to access token, simply replace the value previously held in this environment variable with your new token.
• AIRTABLE_BASE can be found here: https://airtable.com/api, select base then copy from URL: https://airtable.com/[Base Is Here]/api/docs#curl/introduction
• AIRTABLE_TABLE can be found in the docs for the appropriate base, this is not case senstive. IE: tasks
• AIRTABLE_TYPECAST set this to true to allow automatic casting.

Example Config

If you need to support multiple tables, add them to the tables config in the config/airtable.php If your table is on a different base than the one set in the env, add that as well.

Usage

Import the facade in your class.

Get records from that table

• This will only return the first 100 records due to Airtable page size limiation

Get all records from that table.

• This will get all records by sending multiple requests until all record are fetched.
• Optional Parameter which is the delay between requests in microseconds as API is limited to 5 requests per second per base, defaults to 0.2 second.

Get one record from the default table.

Filter records

• First argument is the column name
• Second argument is the operator or the value if you want to use equal '=' as an operator.
• Third argument is the value of the filter

Filter records by formula

• When using where is not enough you may need to pass in raw filter values.
• Airtable reference

Sorting records

• First argument is the column name
• Second argument is the sort direction: asc (default) or desc

You can sort by multiple fields by calling orderBy more than once (a single call with array syntax is not supported):

Set other API Parameters

Create

• Insert a record

First or Create

• First argument will be used for finding existing
• Second argument is additional data to save if no results are found and we are creating (will not be saved used if item already exists)

Update or Create

• First argument will be used to find existing
• Second argument is additional data to save when we create or update

Update

• First argument will be the id
• Second argument is the whole record including the updated fields

Note: Update is destructive and clear all unspecified cell values if you did not provide a value for them. use PATCH up update specified fields

Patch

• First argument will be the id
• Second argument is the field you would like to update

Mass Update or Patch

• Array of data to be updated or patched

Destroy

• Destroy a record

Testing

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Credits

• Steve Williamson
• All Contributors

License

The MIT License (MIT). Please see License File for more information.

Laravel Package Boilerplate

This package was generated using the Laravel Package Boilerplate.