airtable-javascript

This SDK is managed by the SDK Fabric project, a global infrastructure to automatically generate SDKs for every API.

You can find more information about this SDK at TypeHub: https://app.typehub.cloud/d/sdkfabric/airtable

Usage

const client = Client::build('[access_token]');

// Retrieve the user's ID.
const response = await client.meta().getwhoami();

// List records in a table.
const response = await client.records().getall("baseId", "tableIdOrName", "timeZone", "userLocale", 1, 1, "offset", "view", "sort", "filterByFormula", "cellFormat", "fields", true, "recordMetadata");

// Retrieve a single record.
const response = await client.records().get("baseId", "tableIdOrName", "recordId");

// Creates multiple records.
const response = await client.records().create("baseId", "tableIdOrName", new RecordCollection());

// Updates a single record.
const response = await client.records().replace("baseId", "tableIdOrName", "recordId", new Record());

// Updates up to 10 records, or upserts them when performUpsert is set.
const response = await client.records().replaceall("baseId", "tableIdOrName", new BulkUpdateRequest());

// Updates a single record.
const response = await client.records().update("baseId", "tableIdOrName", "recordId", new Record());

// Updates up to 10 records, or upserts them when performUpsert is set.
const response = await client.records().updateall("baseId", "tableIdOrName", new BulkUpdateRequest());

// Deletes a single record.
const response = await client.records().delete("baseId", "tableIdOrName", "recordId");

// Creates a new column and returns the schema for the newly created column.
const response = await client.fields().create("baseId", "tableId", new Field());

// Updates the name and/or description of a field.
const response = await client.fields().update("baseId", "tableId", "columnId", new Field());

// Creates a new table and returns the schema for the newly created table.
const response = await client.tables().create("baseId", new Table());

// Updates the name and/or description of a table.
const response = await client.tables().update("baseId", "tableIdOrName", new Table());

// Returns a list of comments for the record from newest to oldest.
const response = await client.comments().getall("baseId", "tableIdOrName", "recordId");

// Creates a comment on a record.
const response = await client.comments().create("baseId", "tableIdOrName", "recordId", new Comment());

// Updates a comment on a record.
const response = await client.comments().update("baseId", "tableIdOrName", "recordId", "rowCommentId", new Comment());

// Deletes a comment from a record.
const response = await client.comments().delete("baseId", "tableIdOrName", "recordId", "rowCommentId");