Filtering Shift Substitutions in Everbridge REST API: Capabilities and Workarounds

Current Filtering Capabilities

The Everbridge REST API currently supports filtering shift substitutions using scalar fields. For example, you can filter by shiftScheduleId using the following format:

https://api.everbridge.net/rest/scheduling/{orgId}/shiftSubstitutions?filter[shiftScheduleId]={shiftScheduleId}

Limitations on Date-Based Filtering

It's important to note that direct filtering on date-based fields, such as datesApplicable, is not currently supported in the API. This limitation applies to the current API version and affects the ability to filter shift substitutions by specific date ranges.

Alternative Approaches

To work around the date-based filtering limitation, consider the following approaches:

1. Filter by shiftScheduleId to narrow down results

2. Retrieve all records and perform client-side filtering

3. Consult with your Everbridge Account Manager about your specific use case

When using client-side filtering, you'll need to retrieve the complete dataset and implement the date range filtering logic in your application code.