Airtable API Reference¶
GET Record¶
To retrieve an existing record in a table, issue a GET request to the record endpoint. Any “empty” fields (e.g. “”, [], or false) in the record will not be returned.
GET Table¶
fields¶
[ str+ ]: list of str objects. Only data for fields whose names are in this list will be included in the records. If you don’t need every field, you can use this parameter to reduce the amount of data transferred.
filterByFormula¶
str: A formula used to filter records. Only records which satisfy the formula will be returned. If combined with view, only records in that view which satisfy the formula will be returned.
maxRecords¶
Int: The maximum total number of records that will be returned.
pageSize¶
Int: The number of records returned in each request. Must be less than or equal to 100. Default is 100.
sort¶
[ {field: str, direction: “desc” | “asc”}+ ]: A list of sort objects that specifies how the records will be ordered. Each sort object must have a field key specifying the name of the field to sort on, and an optional direction key that is either “asc” or “desc”. The default direction is “asc”. If you set the view parameter, the returned records in that view will be sorted by these fields.
view¶
str: The name or ID of a view in the Counties table. If set, only the records in that view will be returned. The records will be sorted according to the order of the view.
offset¶
str: The recordID to start with. The server returns one page of records at a time. Each page will contain pageSize records, which is 100 by default. If there are more records, the response will contain an offset. To fetch the next page of records, include offset in the next request’s parameters
Post¶
To create a new record, issue a POST request to the table endpoint.
You can include all, some, or none of the field values. Returns the created record object if the call succeeded, including a record ID which will uniquely identify the record within Heritage Legal.
Airtable API performs automatic data conversion from string values if typecast parameter is passed in (click for example). Automatic conversion is disabled by default to ensure data integrity, but it may be helpful for integrating with 3rd party data sources.
Patch¶
To update some (but not all) fields of a record, issue a PATCH request to the record endpoint. Any fields that are not included will not be updated.
To link to new records, add new linked record IDs to the existing array. Be sure to include all existing linked record IDs that you wish to retain. To unlink records, include the existing array of record IDs, excluding any that you wish to unlink.