Hey all!
Confluence Cloud recently released a set of include field parameters to our Get page by id and Get blog post by id endpoints (see changelog here).
One of the recurring themes in the feedback we’ve received when migrating from the to-be deprecated v1 APIs to the v2 APIs is the sheer number of requests needed to retrieve the same amount of information in v2. We’ve added the optional include fields to help address this issue and cut down on the number of calls needed.
For example, clients can now retrieve labels associated with a page via /wiki/api/v2/pages/{page-id}/include-labels=true
.
A few characteristics of the include fields:
- the included fields are metadata of the main entity (e.g. labels, properties, operations) and thus will fall under the same OAuth scope
- pagination, custom sorting, and filtering of the included fields are not supported
We’d also like to take this opportunity to thank the developers and teams who’ve started to migrate over to the v2 APIs. For those who are still planning, we hope this addition helps make the transition easier. We continue to encourage teams to report any gaps they’re facing to developer support as we’re constantly monitoring for gaps and suggestions.