Optional Query Parameters

We will very shortly provide Swagger documentation, much like those for the Events API found here.

Optional Query Parameters

accessibilitySupportId*
activityConceptCollectionId*
activityId
activityInScheme
activityPrefLabel
amenityFeatureType[valueTrue]
availableChannelAdult
availableChannelJunior
facilityTypeId
facilityTypePrefLabel
limit
membershipRequiredAdult
membershipRequiredJunior
page
priceAdult[gte]
priceAdult[lte]
priceJunior[gte]
priceJunior[lte]
priceAny[gte]
priceAny[lte]
providerId
startDate[gte]
startDate[lte]

* Please note that the following two optional query parameters are not currently functional given the current data within the Facilities API:

accessibilitySupportId
activityConceptCollectionId

For more information on using the activityId and activityPrefLabel parameters, please click here.

Optional Query Parameters Examples

activityId=https%3A%2F%2Fopenactive.io%2Factivity-list%230a5f732d-e806-4e51-ad40-0a7de0239c8c
activityInScheme=https%3A%2F%2Fopenactive.io%2Factivity-list
activityPrefLabel=Football
amenityFeatureType[valueTrue]=showers
availableChannelAdult=OpenBookingPrepayment
availableChannelJunior=OpenBookingPrepayment
facilityTypeId=https%3A%2F%2Fopenactive.io%2Ffacility-types%23becfafc0-c63f-444c-aed5-a3665f2d172d
facilityTypePrefLabel=Tennis%20Court
limit=10
membershipRequiredAdult=true
membershipRequiredJunior=false
page=2
priceAdult[gte]=10
priceAdult[lte]=5
providerId=led
startDate[gte]=3000-01-01T09:00:00Z
startDate[lte]=3999-12-31T18:00:00Z

Facets Endpoint

The Facets Endpoint can be found at https://search.imin.co/facilities-api/v2/facets - NB there is a known issue with the Facets Endpoint. It provides an overview of some of the query parameter values that can be used for facilities search, as well as their result count.