I’m thrilled to announce a new version of the cases API (v2) that brings some exciting new features, including a straightforward way to create, update, and close cases. Full documentation is available here. Highlights of the new version are:
- Introduces straightforward, JSON-based case creations and modifications, individually and in bulk. Previously this was only possible by constructing XForms, a complex XML document structure.
- Allows for filtering and querying cases by project-specific case properties, not just metadata.
- Introduces a bulk get-by-id and get-by-external-id endpoint.
- Clearer serialization format that’s more in-line with commonly used terminology elsewhere on HQ.
- Performant deep pagination at scale. This makes it more suitable for fetching very large data sets, such as for populating an analytics database.
We are not deprecating the existing v1 case API at this time. If you have existing integrations, you don’t need to worry about transitioning them to the new endpoint.