Airtable | Composio Docs

Overview

SLUG

AIRTABLE

Description

Airtable merges spreadsheet functionality with database power, enabling teams to organize projects, track tasks, and collaborate through customizable views, automation, and integrations for data management

Authentication Details

OAuth2

client_id

stringRequired

client_secret

stringRequired

oauth_redirect_uri

stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add

scopes

stringDefaults to data.records:read,data.records:write,data.recordComments:read,data.recordComments:write,schema.bases:read,schema.bases:write,user.email:read

bearer_token

string

Bearer Token

token

stringRequired

API Key

generic_api_key

stringRequired

Tools

List bases

SLUG: AIRTABLE_LIST_BASES

Retrieves all airtable bases accessible to the authenticated user, which may include an 'offset' for pagination.

Action Parameters

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create base

SLUG: AIRTABLE_CREATE_BASE

Creates a new airtable base with specified tables and fields within a workspace; ensure field options are valid for their type.

Action Parameters

name

stringRequired

tables

arrayRequired

workspaceId

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create Comment

SLUG: AIRTABLE_CREATE_COMMENT

Creates a new comment on a specific record within an airtable base and table.

Action Parameters

baseId

stringRequired

recordId

stringRequired

tableIdOrName

stringRequired

text

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create Field

SLUG: AIRTABLE_CREATE_FIELD

Creates a new field within a specified table in an airtable base.

Action Parameters

baseId

stringRequired

description

string

name

stringRequired

options

object

tableId

stringRequired

type

stringDefaults to singleLineText

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create multiple records

SLUG: AIRTABLE_CREATE_MULTIPLE_RECORDS

Creates multiple new records in a specified airtable table.

Action Parameters

baseId

stringRequired

records

arrayRequired

tableIdOrName

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create a record

SLUG: AIRTABLE_CREATE_RECORD

Creates a new record in a specified airtable table; field values must conform to the table's column types.

Action Parameters

baseId

stringRequired

fields

objectRequired

tableIdOrName

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create table

SLUG: AIRTABLE_CREATE_TABLE

Creates a new table within a specified existing airtable base, allowing definition of its name, description, and field structure.

Action Parameters

baseId

stringRequired

description

string

fields

arrayRequired

name

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Delete Comment

SLUG: AIRTABLE_DELETE_COMMENT

Deletes an existing comment from a specified record in an airtable table.

Action Parameters

baseId

stringRequired

recordId

stringRequired

rowCommentId

stringRequired

tableIdOrName

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Delete multiple records

SLUG: AIRTABLE_DELETE_MULTIPLE_RECORDS

Deletes up to 10 specified records from a table within an airtable base.

Action Parameters

baseId

stringRequired

recordIds

arrayRequired

tableIdOrName

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Delete Record

SLUG: AIRTABLE_DELETE_RECORD

Permanently deletes a specific record from an existing table within an existing airtable base.

Action Parameters

baseId

stringRequired

recordId

stringRequired

tableIdOrName

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get Base Schema

SLUG: AIRTABLE_GET_BASE_SCHEMA

Retrieves the detailed schema for a specified airtable base, including its tables, fields, field types, and configurations, using the `baseid`.

Action Parameters

baseId

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get Record

SLUG: AIRTABLE_GET_RECORD

Retrieves a specific record from a table within an airtable base.

Action Parameters

baseId

stringRequired

cellFormat

stringDefaults to json

recordId

stringRequired

returnFieldsByFieldId

boolean

tableIdOrName

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get user information

SLUG: AIRTABLE_GET_USER_INFO

Retrieves information, such as id and permission scopes, for the currently authenticated airtable user from the `/meta/whoami` endpoint.

Action Parameters

Action Response

data

objectRequired

error

string

successful

booleanRequired

List Comments

SLUG: AIRTABLE_LIST_COMMENTS

Retrieves all comments for a specific record in an airtable table, requiring existing `baseid`, `tableidorname`, and `recordid`.

Action Parameters

baseId

stringRequired

recordId

stringRequired

tableIdOrName

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

List records

SLUG: AIRTABLE_LIST_RECORDS

Retrieves records from an airtable table, with options for filtering, sorting, pagination, and specifying returned fields.

Action Parameters

baseId

stringRequired

cellFormat

stringDefaults to json

fields

array

filterByFormula

string

maxRecords

integer

offset

string

pageSize

integerDefaults to 100

recordMetadata

array

returnFieldsByFieldId

boolean

sort

array

tableIdOrName

stringRequired

timeZone

stringDefaults to utc

userLocale

string

view

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Update multiple records

SLUG: AIRTABLE_UPDATE_MULTIPLE_RECORDS

Updates multiple existing records in a specified airtable table; these updates are not performed atomically.

Action Parameters

baseId

stringRequired

records

arrayRequired

tableIdOrName

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Update record

SLUG: AIRTABLE_UPDATE_RECORD

Modifies specified fields of an existing record in an airtable base and table; the base, table, and record must exist.

Action Parameters

baseId

stringRequired

fields

objectRequired

recordId

stringRequired

returnFieldsByFieldId

boolean

tableIdOrName

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired