airtable
Advanced tools
Package description
The airtable npm package allows you to interact with the Airtable API, enabling you to manage and manipulate data stored in Airtable bases. It provides a simple and intuitive interface for performing CRUD (Create, Read, Update, Delete) operations on Airtable records.
Initialize Airtable
This code initializes the Airtable client with your API key and base ID, allowing you to interact with a specific Airtable base.
const Airtable = require('airtable');
const base = new Airtable({apiKey: 'YOUR_API_KEY'}).base('YOUR_BASE_ID');Create a Record
This code creates a new record in the specified table with the given field values.
base('Table Name').create({
'Field1': 'Value1',
'Field2': 'Value2'
}, function(err, record) {
if (err) {
console.error(err);
return;
}
console.log(record.getId());
});Read Records
This code retrieves records from the specified table and logs the value of 'Field1' for each record.
base('Table Name').select({
maxRecords: 3,
view: 'Grid view'
}).eachPage(function page(records, fetchNextPage) {
records.forEach(function(record) {
console.log('Retrieved', record.get('Field1'));
});
fetchNextPage();
}, function done(err) {
if (err) { console.error(err); return; }
});Update a Record
This code updates a specific record in the table with a new value for 'Field1'.
base('Table Name').update('recXXXXXXXXXXXXXX', {
'Field1': 'Updated Value'
}, function(err, record) {
if (err) {
console.error(err);
return;
}
console.log(record.get('Field1'));
});Delete a Record
This code deletes a specific record from the table.
base('Table Name').destroy('recXXXXXXXXXXXXXX', function(err, deletedRecord) {
if (err) {
console.error(err);
return;
}
console.log('Deleted record', deletedRecord.id);
});The google-spreadsheet package allows you to interact with Google Sheets in a similar way to how airtable interacts with Airtable bases. It provides methods for reading, writing, and updating data in Google Sheets. Compared to airtable, it is more suited for users who prefer using Google Sheets as their data storage.
The notion-client package provides an interface to interact with Notion databases. It allows you to perform CRUD operations on Notion pages and databases. Compared to airtable, it is more suitable for users who prefer using Notion for their data management and note-taking needs.
The mongodb package is a driver for MongoDB, a NoSQL database. It allows you to perform CRUD operations on MongoDB collections. Compared to airtable, it is more suitable for users who need a more robust and scalable database solution.
Readme
The awesome Airtable javascript library. It's official.
The Airtable API provides a simple way of accessing your data. Whether it's contacts, sales leads, inventory, applicant information or todo items, the vocabulary of the interactions closely matches your data structure. You will use your table names to address tables, column names to access data stored in those column IDs. In other words, Airtable API is your own RESTful API for your base.
We hope you find it fun and easy!
There are two configurable options available:
AIRTABLE_API_KEY)AIRTABLE_ENDPOINT_URL)You can set the options globally via Airtable.configure:
Airtable.configure({ apiKey: 'YOUR_SECRET_API_KEY })
Globally via process env (e.g. in 12factor setup).
export AIRTABLE_API_KEY=YOUR_SECRET_API_KEY
You can also override the settings per connection:
var airtable = new Airtable({endpointUrl: 'https://api-airtable-com-8hw7i1oz63iz.runscope.net/'})
Go to https://airtable.com/api to see the interactive API documentation for your Airtable bases. It'll have examples for all operations you can perform against your bases.
Don't worry, we have tests. Our tests live in a different repository and tests run on every git push. We strive to have all of the API covered along with all API error conditions. If you hit something that's not right, be sure to ping us on intercom or open a github issue.
Here's a few things that we'll expose in the API shortly:
If you have a use case that needs something else, please reach out!
FAQs
The official Airtable JavaScript library.
The npm package airtable receives a total of 126,377 weekly downloads. As such, airtable popularity was classified as popular.
We found that airtable demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 12 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Cyber extortion in the US and Canada hit record levels in 2023, with ransomware attacks surging and median ransom demands skyrocketing, though fewer companies are choosing to pay ransoms.
Security News
Ecma TC39 is meeting this week and has moved key ECMAScript proposals forward, advancing Deferred Import Evaluation, Error.isError(), RegExp Escaping, and Promise.try to the next stages.
Security News
Researchers have demonstrated that teams of LLM agents can exploit zero-day vulnerabilities with a 53% success rate, and the costs of using AI to do so are rapidly becoming more affordable than hiring a human penetration tester.