What's new in Bigin API v2

Welcome to version 2 of the Bigin API. This section provides a consolidated overview of the new endpoints, as well as the latest updates and enhancements introduced in our v2 APIs. By exploring this section, you can leverage the full potential of our APIs and maximize their benefits in your integrations.

[Enhanced] Search Records API

The Search Records API now supports the following comparators for date and date-time data types: equals, not_equal, greater_than, greater_equal, less_than, less_equal, between, in

[New] Email API

The Email API allows you to manage email sending tasks. It includes the following endpoints:

• Get configured from-addresses - Allows you to get the from-addresses.
• Send mail - Allows you to send emails from Bigin programmatically.

[New] Records API

The Records API now introduces 3 new endpoints:

• Records count in a module - Allows you to get the number or count of records available in a module.
• Upsert records - Allows you to insert or update a record with single API call.
• List of deleted records - Allows you to get the list of deleted records.

[Enhanced] Records API

The Records API now supports retrieval of records from a particular Team Pipeline:

• Get records from a Team Pipeline - Allows you to get all records from a Team Pipeline. In order to obtain a particular Team Pipeline's records, the pipeline_id is used as a query parameter.

[Enhanced] Related Lists API

The Related Lists API now supports retrieval of records associated with a specific contact from a particular Team Pipeline:

• Get the Team Pipeline records related to a specific contact - Allows you to get the records in a Team Pipeline that is associated with a specific contact. In order to obtain a particular Team Pipeline's records, the pipeline_id is used as a query parameter.

[New] Change Owner API

The Change Owner API allows you to change the ownership of a record in an organization. It includes the following endpoints:

• Change record owner - Modifies the owner of an existing record.

[New] COQL Query API

The COQL (CRM Object Query Language) Query API allows you to filter and fetch the specific records based on SQL's SELECT query. It includes the following API:

• Get records using COQL query - Allows you get records using the COQL query.

[New] Files API

The Files API allows you to update or download files associated with records. It includes the following endpoints:

• Upload files - Allows you to upload files to an organization.
• Get files - Allows you to download a file.

For a comprehensive list of changes, please visit our API Changelog.