Filter sponsorship worksheet rows
Searches joined donor/recipient/commitment rows within permitted effective programs, excluding explicit program denials in all-program views. Applies current/due status, saved filters, scoped query and sponsorship creation-date bounds. Fields and column_order update current header preferences. Responses retain selected tenant form/display values and only selected commitment metrics; use explicit pageIndex/pageSize to bound results. A search index that cannot supply a safe fallback returns503. Requires permission: one of manage_programs.
Authorizations
Passport bearer token authentication for legacy admin sessions.
Path Parameters
Accessible program id or all programs. Footer/export also accept0 for the combined context.
42
Body
Validated request fields for this operation.
Joined sponsorship worksheet state. Empty filterGroups is ignored; otherwise filter is required. Date bounds apply to sponsorship creation in the resolved timezone. Supplying fields/column_order also persists current worksheet header preferences. Unpaginated requests can return all scoped rows; supply pageIndex/pageSize.
Archived-view selector. Use string false for active and true for archived. Recipient views also support available, sponsored and unsponsored.
"false"
Multiple typed comparisons. Requires filter when present; value is required except supported presence/empty operators. Saved-view filters are sanitized to current allowed fields.
Worksheet search text; recipient search defaults to title/id fields when keysArray is absent.
"Jane"
Legacy comparison/search field keys.
Legacy single comparison operator.
"contains"
Saved view/report from this organization and worksheet module; missing/unmatched ids are ignored.
42
Compatibility alias for savedFilterId.
42
Selected column keys; defaults to saved/current form preferences.
Preferred allowed column ordering.
Allowed selected/system/custom sort key.
"display_name"
Sort direction; unsupported directions normalize to asc where validated.
asc, desc "asc"
One-based worksheet page. Supply with pageSize for predictable bounded pagination.
1
Requested worksheet page length; donor lists default to10 and clamp to at least1.
25
Lower date bound, interpreted with module/saved report date semantics.
"2026-01-01"
Upper date bound; donor created-at range applies when both bounds are supplied and no advanced date override exists.
"2026-10-20"
Allowed field keys to scope query word search; provide with query.
Optional live payment-due classification filter.
current, due "current"
Date-range timezone; defaults to the authenticated organization/admin timezone.
"Africa/Kampala"
Response
Operation result.
length is total matching rows, not this page length. Row shape follows the current form and selected columns.
x >= 042
Echoed active/archive selector; string, boolean or null depending on request/defaults.
Resolved saved/manual filter or column-order metadata; null when no applicable configuration exists. Additional fields include saved date range, selected tab and form-specific context. Recipient views can include general column preferences even without a saved filter.
"all"