GSuite Vault API: Any way to get a list of users on hold programmatically?

Question

Currently, the Google Vault API does not provide a way to get a report of all users in a G-Suite tenant or domain who are on hold in one or more matters. This information is currently available only via the admin interface for Google Vault under Reports/User Holds. It would be great to be able to obtain this report via an API call in JSON format rather than only via the admin UI. Am I missing something or is this functionality already available?

I appreciate that I can perform API operations to search all matters and iterate through the users on hold in each matter to obtain this information. However this is not ideal; there should be a quicker, more efficient way to get this information since such a report is already available via the UI.

Answer 1

Unfortunately, Vault API does not have a method for that. The only way to retrieve this information is to list all matters and iterate through them, as you already mentioned.

File a feature request:

It's not uncommon for a feature to be present only in the UI. If you want to see this implemented on the API, I'd suggest you to report it on Issue Tracker's Vault component.

I looked through the issues of this component, and it looks like this hasn't been requested yet. There's currently a somewhat related feature request, but not exactly what you're looking for:

• Audit reporting functionality

Update:

The original poster filed a feature request in Issue Tracker. I'm add this to the answer in order to give it more visibility.

To anyone who would like to see this feature implemented in the future, I'd suggest starring the issue (star on the top-left) in order to help prioritizing it:

• Vault API: Need API method to return list of all users who have active holds as available in Vault UI