API

Every airtable.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Bases

getMany

bases.getMany List all accessible bases Risk: read

await corsair.airtable.api.bases.getMany({});

Input

Name	Type	Required	Description
`offset`	`string`	No	—

Output

Name	Type	Required	Description
`bases`	`object[]`	Yes	—
`offset`	`string`	No	—

bases full type

{
  id: string,
  name: string,
  permissionLevel: string
}[]

getSchema

bases.getSchema Get the schema (tables, fields, views) of a base Risk: read

await corsair.airtable.api.bases.getSchema({});

Input

Name	Type	Required	Description
`baseId`	`string`	Yes	—
`include`	`visibleFieldIds \| fieldIdsInSynced[]`	No	—

Output

Name	Type	Required	Description
`tables`	`object[]`	Yes	—

tables full type

{
  id: string,
  name: string,
  primaryFieldId: string,
  description?: string,
  fields: {
    id: string,
    type: string,
    name: string,
    description?: string,
    options?: {
    }
  }[],
  views: {
    id: string,
    type: string,
    name: string,
    personalForCreator?: boolean
  }[]
}[]

Records

create

records.create Create a record in a table Risk: write

await corsair.airtable.api.records.create({});

Input

Name	Type	Required	Description
`baseId`	`string`	Yes	—
`tableIdOrName`	`string`	Yes	—
`fields`	`object`	Yes	—
`typecast`	`boolean`	No	—

fields full type

{
}

Output

Name	Type	Required	Description
`records`	`object[]`	Yes	—

records full type

{
  id: string,
  createdTime: string,
  fields: {
  }
}[]

createOrUpdate

records.createOrUpdate Create or update a record using upsert Risk: write

await corsair.airtable.api.records.createOrUpdate({});

Input

Name	Type	Required	Description
`baseId`	`string`	Yes	—
`tableIdOrName`	`string`	Yes	—
`fields`	`object`	Yes	—
`fieldsToMergeOn`	`string[]`	Yes	—
`typecast`	`boolean`	No	—

fields full type

{
}

Output

Name	Type	Required	Description
`records`	`object[]`	Yes	—

records full type

{
  id: string,
  createdTime: string,
  fields: {
  }
}[]

delete

records.delete Delete a record from a table [DESTRUCTIVE] Risk: destructive

await corsair.airtable.api.records.delete({});

Input

Name	Type	Required	Description
`baseId`	`string`	Yes	—
`tableIdOrName`	`string`	Yes	—
`recordId`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`deleted`	`boolean`	Yes	—

get

records.get Get a single record by ID Risk: read

await corsair.airtable.api.records.get({});

Input

Name	Type	Required	Description
`baseId`	`string`	Yes	—
`tableIdOrName`	`string`	Yes	—
`recordId`	`string`	Yes	—
`returnFieldsByFieldId`	`boolean`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`createdTime`	`string`	Yes	—
`fields`	`object`	Yes	—

fields full type

{
}

search

records.search Search and list records with optional filters Risk: read

await corsair.airtable.api.records.search({});

Input

Name	Type	Required	Description
`baseId`	`string`	Yes	—
`tableIdOrName`	`string`	Yes	—
`fields`	`string[]`	No	—
`filterByFormula`	`string`	No	—
`maxRecords`	`number`	No	—
`pageSize`	`number`	No	—
`sort`	`object[]`	No	—
`view`	`string`	No	—
`cellFormat`	`json \| string`	No	—
`timeZone`	`string`	No	—
`userLocale`	`string`	No	—
`returnFieldsByFieldId`	`boolean`	No	—
`offset`	`string`	No	—

sort full type

{
  field: string,
  direction?: asc | desc
}[]

Output

Name	Type	Required	Description
`records`	`object[]`	Yes	—
`offset`	`string`	No	—

records full type

{
  id: string,
  createdTime: string,
  fields: {
  }
}[]

update

records.update Update fields on an existing record Risk: write

await corsair.airtable.api.records.update({});

Input

Name	Type	Required	Description
`baseId`	`string`	Yes	—
`tableIdOrName`	`string`	Yes	—
`recordId`	`string`	Yes	—
`fields`	`object`	Yes	—
`typecast`	`boolean`	No	—

fields full type

{
}

Output

Name	Type	Required	Description
`records`	`object[]`	Yes	—

records full type

{
  id: string,
  createdTime: string,
  fields: {
  }
}[]

Overview

Plugins

Bases

getMany

getSchema

Records

create

createOrUpdate

delete

get

search

update

Overview

Plugins

​Bases

​getMany

​getSchema

​Records

​create

​createOrUpdate

​delete

​get

​search

​update

Bases

getMany

getSchema

Records

create

createOrUpdate

delete

get

search

update