Introducing Bigin API Version 2.0

Introducing Bigin API Version 2.0

Hello all! We're thrilled to announce the release of the highly anticipated Bigin API v2. The newest version of our API brings a bunch of new endpoints, updates, and improvements, and is highly focused on introducing the most commonly requested APIs, such as COQL, Send Mail, Change Owner, and more. Additionally, it enhances existing APIs to ensure better alignment with the product.

What's new?

What's improved?

  • The Search Records API has been enhanced to support all related comparators for date and date-time data types.
  • The Records API has been enhanced to support the retrieval of records from a particular Team Pipeline.
  • The Related Lists API has been enhanced to support the retrieval of records associated with a specific contact from a particular Team Pipeline.

Major changes: What you need to know

  • Renamed the Deals module to Pipelines. This change reflects across the Bigin API, including request URLs, response objects, and scopes.
  • The terminology for Layout has been changed to Pipeline, and what was previously called Pipeline is now Sub-Pipeline in all corresponding request URLs and response objects.
For more detailed explanation of the latest APIs and enhancements, please refer to our What's new page and Changelog guides.

To start exploring the capabilities of Bigin API v2, head over to our updated documentation and check out our detailed API reference.

We would like to inform you that existing Bigin API v1 clients will remain unaffected, as we have ensured backward compatibility support. However, we advise everyone to start the migration process to the new Bigin API v2. We're yet to finalize the deprecation timeline, but until then, we'll keep supporting v1 APIs. After arriving at a retirement date for v1 APIs, we'll post an update here so that you can start migrating your existing integrations/toppings to v2.

But wait, there's more!

API Credits Dashboard

We're also delighted to share our latest feature: API Credits Dashboard. This feature provides details about the number of API calls consumed in a 24-hour window, and offers a clear overview of the total credits available in the organization's account, both used and unused credits, as well as individual user API consumption. See the help doc for more details.

We encourage you to share your feedback and thoughts on the new version. If you have any questions or need assistance, don't hesitate to post them in our dedicated Bigin Developer Community or reach out to us.

What's next!

We're planning to release API endpoints for Team Pipelines, Sub-Pipelines, and Stages soon. Stay tuned for our official announcement!

Thank you!