Skip to main content
POST
Filter sponsorship worksheet rows

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Path Parameters

program_id
required

Accessible program id or all programs. Footer/export also accept0 for the combined context.

Example:

42

Body

application/json

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.

filter
string

Archived-view selector. Use string false for active and true for archived. Recipient views also support available, sponsored and unsponsored.

Example:

"false"

filterGroups
object[]

Multiple typed comparisons. Requires filter when present; value is required except supported presence/empty operators. Saved-view filters are sanitized to current allowed fields.

query
string

Worksheet search text; recipient search defaults to title/id fields when keysArray is absent.

Example:

"Jane"

keysArray
string[]

Legacy comparison/search field keys.

comparisonOperator
string

Legacy single comparison operator.

Example:

"contains"

savedFilterId
integer

Saved view/report from this organization and worksheet module; missing/unmatched ids are ignored.

Example:

42

saved_filter_id
integer

Compatibility alias for savedFilterId.

Example:

42

fields
string[]

Selected column keys; defaults to saved/current form preferences.

column_order
string[]

Preferred allowed column ordering.

sortKey
string

Allowed selected/system/custom sort key.

Example:

"display_name"

sortOrder
enum<string>

Sort direction; unsupported directions normalize to asc where validated.

Available options:
asc,
desc
Example:

"asc"

pageIndex
integer

One-based worksheet page. Supply with pageSize for predictable bounded pagination.

Example:

1

pageSize
integer

Requested worksheet page length; donor lists default to10 and clamp to at least1.

Example:

25

date_from
string<date>

Lower date bound, interpreted with module/saved report date semantics.

Example:

"2026-01-01"

date_to
string<date>

Upper date bound; donor created-at range applies when both bounds are supplied and no advanced date override exists.

Example:

"2026-10-20"

header_keys
string[]

Allowed field keys to scope query word search; provide with query.

status
enum<string>

Optional live payment-due classification filter.

Available options:
current,
due
Example:

"current"

date_range_timezone
string

Date-range timezone; defaults to the authenticated organization/admin timezone.

Example:

"Africa/Kampala"

Response

Operation result.

length is total matching rows, not this page length. Row shape follows the current form and selected columns.

data
object[]
required
length
integer
required
Required range: x >= 0
Example:

42

filter
any
required

Echoed active/archive selector; string, boolean or null depending on request/defaults.

applied_filters
object | null
required

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.

program_id
string
Example:

"all"