Skip to content

[LFXV2-1443] docs: document filters, filters_all, and filters_or query params in README #42

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
andrest50 wants to merge 2 commits into
base: main
Choose a base branch
from
+3 −0
Open

[LFXV2-1443] docs: document filters, filters_all, and filters_or query params in README #42

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c15e1ee
docs: document filters, filters_all, and filters_or query params in R…
andrest50 Apr 9, 2026
3b0b297
docs: clarify filters vs filters_all relationship in README
andrest50 Apr 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,9 @@ Authorization: Bearer <jwt_token>
- `parent`: Parent resource for hierarchical queries
- `tags`: Array of tags to filter by (OR logic - matches resources with any of these tags)
- `tags_all`: Array of tags to filter by (AND logic - matches resources that have all of these tags)
- `filters`: Legacy/backwards-compatible array of exact field filters with AND logic (format: `field:value`, e.g. `stage:Active`). Fields are auto-prefixed with `data.`
- `filters_all`: Preferred array of exact field filters with AND logic (same `field:value` format). If both `filters` and `filters_all` are provided, both sets of filters are applied and combined with AND logic
- `filters_or`: Array of exact field filters with OR logic — at least one must match (same `field:value` format)
- `cel_filter`: CEL expression for advanced post-query filtering (see [CEL Filter](#cel-filter) section)
- `date_field`: Date field to filter on (within data object) - used with date_from and/or date_to
- `date_from`: Start date (inclusive). Format: ISO 8601 datetime or date-only (YYYY-MM-DD). Date-only uses start of day UTC
Expand Down
Loading