Versioning and Deprecation

BigPanda improves its APIs continuously. Most updates are seamless and require no changes on your side. Occasionally a new API version is necessary, and older versions are deprecated and eventually removed.

Version guidance

When an endpoint exists in more than one version, prefer the newest version for new work. Newer versions add capabilities such as schema-aware configuration, improved pagination, and consistent error handling. Older versions remain available so existing automations keep working until they are retired.

Migrate to a new API version

When you migrate an integration to a newer endpoint:

Update the base URL if it changed between versions.

Validate the authentication type. All current APIs require a User API Key. If your integration uses an Org Token, issue a User API Key with the appropriate role first.

Validate body fields and values. Payload shapes change occasionally to make space for new functionality. Review the new payload against your existing one.

Set pagination or filter rules. Some endpoints paginate or filter by default. For large datasets, configure filters and scripted recurring calls.

Test before you cut over. Send sample calls against the new endpoint before relying on it in production.

Where deprecations are announced

Upcoming deprecations can be found on the Release Notes.

Next steps

Authentication and headers: Confirm your token type before migrating.

Pagination: Add paging when moving to a newer endpoint.

Best practices: Test changes safely.

Version guidance#

Migrate to a new API version#

Where deprecations are announced#

Next steps#

Version guidance

Migrate to a new API version

Where deprecations are announced

Next steps