Add querystring parameters to limit which fields are returned #201
Labels
api
enhancement
New feature or request
Partner: VtS
Supporting or integrating with Vaccinate the States
Milestone
For clients who don’t need detailed data, cutting some fields (e.g.
availability.slots
oravailability.capacity
) from responses can make the response smaller and make the queries faster since joins take less memory. We should add a querystring parameter than allows clients to ask for fewer fields.I’m not 100% sure on the best form for this; it could be as simple as some presets, like
?detail_level=light
, or it could be a comma-separated list of fields, like?fields=id,external_ids,name,availability.valid_at,availability.available,availability.products
.This is not yet a high priority need, but I’m noting it down since Vaccinate the States wants to integrate on the front-end instead of the back-end, and this could be a particularly useful feature for that.
The text was updated successfully, but these errors were encountered: