Search

All search-by-IDs endpoints return complete result sets without pagination. This means that all matching settings will be returned in a single response, without the need for page navigation.

The following endpoints allow searching for a current setting:

GET/settings-objects/{settingType}

GET/settings-objects/{settingType}/getIds

The activeFrom parameter filters results to include only settings that are active at the specified date-time. In order to return a current setting the activeFrom value must be at or after the activeFromDate of the current setting, but before the activeFromDate of a scheduled setting (if it exists).

The two endpoints below allow searching for a scheduled setting, but the 'activeFrom' value must be at or after the activeFromDate of the scheduled setting.

GET/settings-objects/{settingType}

GET/settings-objects/{settingType}/getIds

It is far easier to search for a scheduled setting via an alternative endpoint dedicated only for schedule settings:

GET/settings-objects/scheduled-settings/{settingType}

This endpoint does not support the activeFrom paramater supported therefore all scheduled settings that match the search criteria are returned.

Each setting can define a subset of its fields which can be used as searchable fields.

To see how to define setting-specific searchable fields go to Searchable Fields