Segments

Saved filter presets (segments) that define a reusable subset of records in a given module, shared across users or teams.

Each segment stores a filter, the target module name, and optionally a customModuleId. The filter is not JSON: it is the same string expression as the filter query parameter of the record list endpoints (field operator value terms joined with &/; or |, groups in parentheses) - see that parameter for the full grammar and the filter property below for an example.

Visibility follows the segment's audience - its assigned users, teams and categories. A segment with no audience at all is readable by everyone and may be edited or deleted only by an administrator; a segment with an audience is visible to its members only, and they are also the ones who may edit or delete it. Listing is audience-scoped too, so GET /segment returns what the caller may see rather than every segment in the system. Creating a segment is administrator-only - belonging to an audience does not grant it.

Segments appear as quick-filter shortcuts in list views and can be ordered via orderIndex.