Filtering

We provide a generic way to filter and search results whenever a GET request to a resource returns a collection of records.

When listing records, you’ll often only want to return those which match specific criteria, such as listing all the notices of a given type or those created after a particular date.

The ‘Filter’ Parameter

This is done using the ‘filter’ parameter on the request. This parameter can contain a number of keys which are the combination of the attribute name and operator, followed by the value.

curl curl -X GET https://api.sorryapp.com/v1/pages/:page_id/notice \
   -d "filter[created_at_gt]=2025-01-01" \
  -H "Authorization: Bearer token"

Filtering ‘Included’ Records

You can also apply these exact same filters against collections nested under a singular resource which you’ve included using the ‘?include’ parameter.

Here you have to submit a nested parameter within filter which corresponds to the name of the included collection, this, in turn, contains the filters for that collection.

curl curl -X GET https://api.sorryapp.com/v1/pages/:page_id \
  -d include="notices"\
  -d "filter[created_at_gt]=2025-01-01" \
  -H "Authorization: Bearer token"

Available Operators

The examples above both use the *_gt operator, but there are lots of other useful operators you can use in much the same manner.