Zoom API: Filtering REST API responses

API and Webhooks
1

API Endpoint(s)
–api.zoom.us/v2/rooms/locations
–api.zoom.us/v2/metrics/zoomrooms
–api.zoom.us/v2/rooms/A1B2C3D4E5F6G7H8I9J10/devices

Description
I am using the above endpoints to create a data structure to map our Zoom ecosphere. Bizarrely, the trouble is, there’s too much information! The APIs give me everything I need, plus more… however, my boss only wants me to model our Zoom ecosphere as it relates to Structured Finance, which has specific rooms in specific buildings, in specific cities, in specific countries. He doesn’t want the other areas such as Retail Banking, Corporate Finance, HR, Admin, as for a company with offices around the world, to include all of that will result in a massive data set!!!

I can write code to filter the data for values at each level (selected countries, selected states, selected cities, selected buildings, selected rooms), but I wondered if there was something on the API side that would allow me to filter what is returned, before I made the call to the REST API. I was thinking of it as a filter, but my boss offered a different perspective (for effectively the same thing): ‘is there a way to limit what you are allowed to see, as a Structured Finance developer should only get Structured Finance results’.

2

Hi @tad.andymarshall
Thanks for reaching out to us and welcome to our community!

I see what you mean and think there could be a way to accomplish this.
Have you checked out this support article about Zoom Rooms’ location hierarchy?

You could create a structure that will help you manage the rooms.

Please let me know if this helps in any way.

What you could do with our API is make sure to use query parameters in your requests, that way you will only get the data you need. For example in the Get rooms location endpoint, you could add a parent location ID or a type of room query param, and that way you will only get the rooms that you need.

3

Hi @elisa.zoom
Thank you so much for responding!

I’ve looked at your suggestions, and I think that would be the way to go. A combination of filtering at source, using query parameters on the REST API calls, and filtering within the device hierarchy (if needed) using code snippets to fine tune the filtering. Perfect!

Regards

Andy

4

Of course! @tad.andymarshall
Happy to hear that this helped!
Feel free to reach out to us in the future if you need anything else!
Cheers,
Elisa