--- title: "build runtime filter. 🔐" method: POST path: "/v3/filter/runtime" tags: ["filter"] --- # build runtime filter. 🔐 `POST /v3/filter/runtime` ## Request - Base URL: `https://rest.cleverreach.com` - URL: `https://rest.cleverreach.com/v3/filter/runtime` - Auth: API key in header `Authorization` returns a list of receivers, filtered by an on-the-fly filter

Example Post Data:
{
   "groups": [1,2,3],
   "operator": "AND",
   "rules": [
      {
         "field":"email",
         "logic":"contains",
         "condition":"@"
      }
   ],
   "orderby": "activated desc",
   "pagesize": 250,
   "page": 0
}
Possible Operators
  1. OR
  2. AND (default)

Available Logics:
  1. eq - equals
  2. neq - not equals
  3. sm - smaller
  4. bg - bigger
  5. isnull - is empty
  6. notisnull - not empty
  7. contains - contains given string
  8. begins - begins with
  9. ends - ends with
  10. ismale - given field is male
  11. isfemale - given field is female

general available fields:
  1. email - (email of the receiver)
  2. source - (import source of the email)
  3. imported - (timestamp of receiver import)
  4. registered - (timestamp of receiver registration)
  5. activated - (timestamp of receiver activation)
  6. deactivated - (timestamp of receiver deactivation)
  7. bounced - (timestamp of receiver bounce)
  8. points - (points of the receiver)
  9. last_location - (last location of receiver)
  10. last_client - (last mail client used by receiver)
  11. crevent_mail_send (logic: eq, condition: mailing_id -> receiver of certain mailing)
  12. crevent_mail_open (logic: eq, condition: mailing_id -> opened mail of certain mailing)
  13. crevent_mail_click (logic: eq, condition: mailing_id -> clicked on mail of certain mailing)
  14. crevent_mail_bounce (logic: eq, condition: mailing_id -> bounced mail of certain mailing)
  15. all attributes (if global and group attributes have the same name, group ones will be favoured)

## Request body - FilterRuntimeModel - `rules` string[], required: Array of rules - `groups` string[], required: Array of group IDs - `operator` string: the default operator to be used (default: AND) - `orderby` string: Order by given Field f.e. "registered DESC". only 1 possible - `detail` integer: Detail depth (bitwise combinable) (0: none, 1: events, 2: orders, 4: tags) - `pagesize` integer: Pagesize (default: 250) - `page` integer: Page (default: 0) - `mode` string: Filter mode (e.g., 'active', 'inactive', 'bounce', 'softbounce', 'hardbounce') ## Response `200` Success - string[] ## Changes - **2026-11-02** `310b1a47f1ac`: 1 info - endpoint added [Operation history](https://skmtc.dev/cleverreach/apis/cleverreach-rest-api/changes/v3/filter/runtime/post.md) --- [API](https://skmtc.dev/cleverreach/apis/cleverreach-rest-api.md) - [All operations](https://skmtc.dev/cleverreach/apis/cleverreach-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/cleverreach/apis/cleverreach-rest-api/revisions/310b1a47f1ac?raw)