Skip to main content
POST
Count donors matching worksheet filters

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Body

application/json

Validated request fields for this operation.

Donor form worksheet state. The path supplies form scope; filters/search/date/sort are resolved with saved view settings. filter is conditionally required with filterGroups. Pagination defaults to page1, size10; hysform_id=all combines forms.

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.

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"

hysform_id

Form scope; omitted/null/empty/all combines donor forms.

Example:

42

Response

Operation result.

count
integer
required
Required range: x >= 0
Example:

42