Skip to navigation
SchoolSet APIFundraising Pledges

Export filtered pledges

Exports the pledges matching the same page and filter parameters as the pledge list as an XLSX download. If no rows match, the endpoint returns a 422 JSON error instead.

Authentication

AuthorizationBearer

The signed-in SchoolSet user token sent by the frontend.

Request

This endpoint expects an object.
pageintegerOptional>=1
per_pageintegerOptional1-200
sortstringOptional
filtermap from strings to anyOptional
Page filters such as search

Response

XLSX pledge export

Errors

401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error