Get base schema

getBaseSchema returns the complete visible schema for a base. Use it to discover table, field, and view IDs or validate dynamic mappings.

Example

automations/read-airtable-schema.automation.ts

import { automation, onHttpRequest } from "automate.ax"
import { getBaseSchema } from "automate.ax/airtable"

export default automation("Read the CRM schema", () => {
  onHttpRequest({ scope: "automation" })
  getBaseSchema({ base: "CRM" })
})

Inputs

Input	Type	Required	Default	Description
`base`	`string`	Yes	—	Exact base name or stable base ID.
`account`	`string \| IntegrationAccountReference<"airtable">`	No	Project default	Connected Airtable account.

Output

Returns { tables: AirtableTable[] }. Each table includes id, name, description?, primaryFieldId, fields, and views. A field includes id, name, type, description?, and provider-specific options?; a view includes id, name, and type. The connection needs schema.bases:read. Base-name matching is exact; use the ID returned by List bases when names may collide or change.

Get started

Concepts

Reference

Example

Inputs

Output

​Example

​Inputs

​Output

Example

Inputs

Output