Changelog

3.2.0 (2025-08-17)

• Added several new fields returned in metadata models. - PR #434

3.1.1 (2025-04-07)

• Fix a bug affecting from_id() when use_field_ids=True. - PR #431

3.1.0 (2025-04-07)

• Added Field.field_schema() to type-annotated ORM fields. - PR #426

• Fix for incorrect type annotations on FunctionCall. - PR #429

3.0.2 (2025-02-25)

• Fixed broken search feature in the library docs. - PR #423

• Fix for #421 which prevented ORM link fields from fetching records of models that used field IDs instead of field names. - PR #422

3.0.1 (2024-12-06)

• Fix for #415 which caused an endless loop when making a request via POST /listRecords. - PR #416, PR #417

2.3.7 (2024-12-06)

• Fix for #415 (see above).

3.0 (2024-11-15)

• Added support for new enterprise API endpoints. - PR #407

• Refactored methods/properties for constructing URLs in the API. - PR #399

• Dropped support for Pydantic 1.x. - PR #397

• Dropped support for Python 3.8. - PR #395

• Added support for Upload attachment via Table.upload_attachment or AttachmentsList.upload. - PR #389

• Added pyairtable.testing.MockAirtable for easier testing. - PR #388

• Changed the return type of Model.save from bool to SaveResult. - PR #387

• Added use_field_ids= parameter to Api. - PR #386

• Changed the behavior of Model.save to no longer send unmodified field values to the API. - PR #381

• Added command line utility and ORM module generator. See Using the Command Line. - PR #376

• Added Enterprise.grant_access <pyairtable.Enterprise.grant_access> and Enterprise.revoke_access <pyairtable.Enterprise.revoke_access>. - PR #373

• Added support for memoization of ORM models. - PR #369

• Refactored methods for accessing ORM model configuration. - PR #366

• Added ORM fields that require a non-null value. - PR #363

• Renamed return_fields_by_field_id= to use_field_ids=. - PR #362

• Removed the pyairtable.metadata module. - PR #360

• Support use_field_ids in the ORM. - PR #355

• Added ORM field type SingleLinkField for record links that should only contain one record. - PR #354

• Changed the type of created_time from str to datetime, along with all other timestamp fields used in API: pyairtable.models. - PR #352

• TextField and CheckboxField return "" or False instead of None. - PR #347

• Rewrite of pyairtable.formulas module. See Building Formulas. - PR #329

2.3.6 (2024-11-11)

• Fix for #404 related to enterprise endpoint changes. - PR #405, PR #406

2.3.5 (2024-10-29)

• Fix for environment variables not getting passed to the requests library (#398). - PR #401

2.3.4 (2024-10-21)

• Fixed a crash at import time under Python 3.13. - PR #396

2.3.3 (2024-03-22)

• Fixed a bug affecting ORM Meta values which are computed at runtime. - PR #357

• Fixed documentation for the ORM module. - PR #356

2.3.2 (2024-03-18)

• Fixed a bug affecting pyairtable.metadata.get_table_schema(). - PR #349

2.3.1 (2024-03-14)

• Fixed a bug affecting how timezones are parsed by DatetimeField. - PR #342

• Fixed a bug affecting create_table(). - PR #345

2.3.0 (2024-02-25)

• A breaking API change was accidentally introduced. Read more in Migrating from 2.2 to 2.3.

• Added support for Managing permissions and shares and Managing users. - PR #337

• Added Enterprise.audit_log to iterate page-by-page through audit log events. - PR #330

• Api.base, Api.table, and Base.table will use cached base metadata when called multiple times with validate=True, unless the caller passes a new keyword argument force=True. This allows callers to validate the IDs/names of many bases or tables at once without having to perform expensive network overhead each time. - PR #336

2.2.2 (2024-01-28)

• Enterprise methods user(), users(), and group() now return collaborations by default. - PR #332

• Added more helper functions for formulas: LESS(), LESS_EQUAL(), GREATER(), GREATER_EQUAL(), and NOT_EQUAL(). - PR #323

2.2.1 (2023-11-28)

• update() now accepts return_fields_by_field_id=True - PR #320

2.2.0 (2023-11-13)

• Fixed a bug in how webhook notification signatures are validated - PR #312

• Added support for reading and modifying Metadata - PR #311

• Added support for the ‘AI Text’ field type - PR #310

• Batch methods can now accept generators or iterators, not just lists - PR #308

• Fixed a few documentation errors - PR #301, PR #306

2.1.0 (2023-08-18)

• Added classes and methods for managing Webhooks. - PR #291

• Added compatibility with Pydantic 2.0. - PR #288

2.0.0 (2023-07-31)

See Migrating from 1.x to 2.0 for detailed migration notes.

• Added Comment class; see Commenting on Records. - PR #282

• batch_upsert() now returns the full payload from the Airtable API. - PR #281

• ORM module is no longer experimental and has a stable API. - PR #277

• Added Model.batch_save and Model.batch_delete. - PR #274

• Added Api.whoami method. - PR #273

• pyAirtable will automatically retry requests when throttled by Airtable’s QPS. - PR #272

• ORM Meta attributes can now be defined as callables. - PR #268

• Removed ApiAbstract. - PR #267

• Implemented strict type annotations on all functions and methods. - PR #263

• Return Model instances, not dicts, from Model.all and Model.first. - PR #262

• Dropped support for Python 3.7. - PR #261

• ORM supports all Airtable field types. - PR #260

1.5.0 (2023-05-15)

• Add support for Airtable’s upsert operation (see Updating Records). - PR #255

• Fix return_fields_by_field_id in batch_create() and batch_update(). - PR #252

• Fix ORM crash when Airtable returned additional fields. - PR #250

• Use POST for URLs that are longer than the 16k character limit set by the Airtable API. - PR #247

• Added endpoint_url= param to Table, Base, Api. - PR #243

• Added ORM LookupField. - PR #182

• Dropped support for Python 3.6 (reached end of life 2021-12-23) - PR #213

1.4.0 (2022-12-14)

• Added pyairtable.retry_strategy().

• Misc fix in sleep for batch requests PR #180

1.3.0 (2022-08-23)

• Added new LOWER formula - PR #171. See pyairtable.formulas.

• Added match(..., match_any=True) to match()

• Added return_fields_by_field_id in get()

1.2.0 (2022-07-09)

• Fixed missing rate limit in batch_update() - PR #162

• Added support for new parameter return_fields_by_field_id - PR #161. See updated Parameters.

• Added new OR formula - PR #148. See pyairtable.formulas.

1.1.0 (2022-02-21)

• Added support for cellFormat - PR #140. See updated Parameters.

1.0.0 (2021-08-11)

• pyAirtable rewrite for 1.x - see Migration Guide.

0.15.3 (2021-07-26)