This announcement details a potentially breaking change to the Core API. The changes might affect you if your company uses our API in one of your integrations or tools to return a list of company, team, or individual tags.
Previously, these endpoints returned all the tags in one response, but we are changing this behavior so that the endpoints return paginated results instead. This change will result in better API performance when retrieving tags from a list of potentially hundreds or thousands of tags.
If your integrations have been relying on the endpoints to return all the tags in one response, you will have to update those integrations so that they paginate through the list of results instead. You can learn how to handle paginated results on our Developer Portal.
We understand changes take time to implement, so we are releasing these changes in a way that should limit unexpected behavior.
For the next 3 months, the tags endpoints will return paginated results only if you specify a
page_token query string parameter. If you don't specify these parameters in the request, the endpoints will continue to return unpaginated results. After 3 months, the endpoints will return paginated results regardless of the parameters specified in the request.
Please update your integrations by November 4th, 2023 to avoid missing tags in your integrations. We will roll the changes out gradually at the 3-month mark, so if you encounter any unexpected issues after November 4th, let us know, and we will roll back the changes for your company. You can also let us know if you need an extension to make these changes.
Thank you for your time and attention in this matter. We hope that paginated results offer your integrations a faster and more performant experience.