The imin Platform
2.0.0
1.0.02.0.0
2.0.0
1.0.02.0.0
  • Introduction to the imin Platform
  • Using the Platform
    • imin's Platform Products
    • Authentication
    • Our Platform Data
      • Understanding Responses
      • Namespaces and Extensions
      • Defensive Data Consumption
      • Mocking the Interface
  • platform products
    • Search
      • imin Events API
        • Events API Reference
        • Virtual & Physical Sessions
        • Concepts
          • EventSeries
          • ScheduledSessions and eventSchedules
          • Activities and Collections
            • Activities
            • Activity Concept Collections
          • Accessibility Support
          • Prices
        • Filters
          • Modes
          • Age Ranges
          • Dates and Times
          • Activities and Concept Collections
          • High Frequency Sessions
      • imin Facilities API
        • Query Parameter Search
          • Mandatory Query Parameters
            • mode=discovery-geo
            • mode=upcoming-slots
          • Optional Query Parameters
        • ByID Search
          • FacilityUse By-ID
          • Slot By-ID
        • FacilityUses and IndividualFacilityUses
        • Slots
        • Facilities Slot Booking
      • imin Places API [BETA]
        • Example Request & Response
    • Firehose
      • Introduction to the Firehose
      • Accessing the Firehose
      • Firehose Usage Policy & Restrictions
      • Firehose and Search
      • Bookable Firehose Feeds
      • Bookable Sellers Feed
      • Attribution Catalog Endpoint
    • Live Timetables
      • Pre-Requisites: Open Data Feeds
      • The Onboarding Process
        • 1. Ensuring your Data Offers the Best User Experience
        • 2. Setting up and Embedding your First Timetable
        • 3. Setting up the Rest of your Timetables
        • 4. Activating Booking via Guest Checkout
      • Features Available Upon Request
      • Styling the Live Timetables
      • FAQs
    • Data Dashboard
  • incorporating book and pay
    • imin Branded Checkout
      • Introduction
      • Setup
        • Information We Require From You
        • Actions You Need to Complete
      • Authenticated Checkout
        • Testing [BETA]
        • 👪Group Booking [BETA]
      • Standalone Checkout
      • Firehose and Checkout [BETA]
        • Loading the Checkout via Firehose
    • imin Booking Platform
      • Customer Account Management
        • Create Customer Account
        • Update Customer Account
        • Get Customer Account
        • Delete Customer Account
        • Example Scenario
        • Payment Card Management
        • Linked Accounts
        • Entitlement
          • Evidence Requests
          • Entitlement Pricing in Search
          • Entitlement Pricing in Checkout
        • Access Pass
        • Webhooks
      • Orders
        • Order History
        • Order (by ID)
        • Cancellations & Refunds
      • Upcoming OrderItems
      • Receipt (by ID)
  • imin and booking systems
    • Seller Onboarding
      • API
  • HINTS & TIPS
    • Get the Best Out of Search
      • Displaying Schedule Information
      • URLs and Offering a Call to Action
      • Searching by Activity
      • Your Search Results and HighFrequencySessions
      • Customer Specific Images
  • Info for Data Publishers
    • Your RPDE Feed & the imin Platform [BETA]
      • Providing Places Data [BETA]
      • Providing Schedule Information [BETA]
Powered by GitBook
On this page
  • Optional Query Parameters
  • Optional Query Parameters Examples
  • Facets Endpoint
  1. platform products
  2. Search
  3. imin Facilities API
  4. Query Parameter Search

Optional Query Parameters

Previousmode=upcoming-slotsNextByID Search

Last updated 2 years ago

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

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

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

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

The Facets Endpoint can be found at - 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.

here
here
https://search.imin.co/facilities-api/v2/facets