Convenience wrapper arounc the get base schema endpoint used to retreive the table schema of all tables in the base.
Object containing the parsed JSON returned by the API.
Convenience wrapper arounc the list bases endpoint used to retreive a list of available bases in the account.
Object containing the parsed JSON returned by the API.
If a convenience function fails, this property will contain the last error as a string message, otherwise it will be undefined
.
Execute a request against the Airtable API. For successful requests, the HTTPResponse object will contain an object or array or objects decoded from the JSON returned by Airtable as appropriate to the request made. Refer to Airtable API documentation for details about the expected parameters and responses. Drafts will handle wrapping the request in the appropriate OAuth authentication flow and translating passed and received data object to and from JSON.
Optional
data?: { An object containing data to be encoded into the HTTP body of the request.
Optional
headers?: { An object contain key-values to be added as custom headers in the request. There is no need to provide authorization headers, Drafts will add those.
The HTTP method, like "GET", "POST", etc.
Optional
parameters?: { An object containing key-values to be added to the request as URL parameters. Drafts will take care of encoding these.
The URL of the API endpoint in the Airtable API. This should include the entire URL, including api version, usually something like https://api.airtable.com/v0/...
Static
createConvenience wrapper arounc the list records endpoint used to retreive records in a table.
Valid id of an existing base in the Airtable account.
Valid id, or name, of a table that exists in the Airtable account.
An object containing a single record field values, or an array of up to 10 record field values to create. See API docs for details on configuring records.
Object containing the parsed JSON returned by the API.
Convenience wrapper arounc the list records endpoint used to retreive records in a table.
Valid id of an existing base in the Airtable account.
Valid id, or name, of a table that exists in the Airtable account.
Optional
options: objectObject containing the parsed JSON returned by the API.
Convenience wrapper arounc the list records endpoint used to update values of an existing record in a table.
Valid id of an existing base in the Airtable account.
Valid id, or name, of a table that exists in the Airtable account.
Valid id of an existing record in the table.
An object containing field values. See API docs for details.
Object containing the parsed JSON returned by the API.
Airtable objects can be used to work bases and tables in an Airtable account. Integration works via the Airtable API so plan to reference their documentation for details on parameters and return value objects. Drafts will take care of the OAuth authentication, and conversion to and from JSON for passing parameters and receiving return values.
Example