Skip to main content
GET
List pledges

Authorizations

Authorization
string
header
required

Organization API key created in Grain Settings → API. The key determines the organization and is limited to its assigned resource scopes. Write scopes imply the corresponding read scope.

Headers

X-Organization-Id
string

Required with OAuth access tokens. Optional with organization API keys; if supplied, it must match the key's organization.

Query Parameters

page
integer
default:1

Page number (1-based)

Required range: x >= 1
limit
integer
default:20

Records per page

Required range: 1 <= x <= 1000
donorId
string
fundId
string
campaignId
string
status
enum<string>
Available options:
ACTIVE,
CANCELLED
sortBy
enum<string>

When omitted, pledges are ordered by createdAt descending. Progress sort loads computed fulfillment for filtered pledges.

Available options:
donor,
fund,
campaign,
pledged,
fulfilled,
progress,
pace,
status,
createdAt
sortDir
enum<string>

When sortBy is sent, ascending or descending order. Omit with sortBy to accept server defaults (typically desc).

Available options:
asc,
desc

Response

Paginated pledges

pledges
object[]
pagination
object
Last modified on August 23, 2026