Skip to main content
GET
/
api
/
v1
/
pledges
List pledges
curl --request GET \
  --url https://api.grainledger.com/api/v1/pledges \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Organization-Id: <x-organization-id>'

Documentation Index

Fetch the complete documentation index at: https://docs.grainledger.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
X-Organization-Id
string<uuid>
required

Organization ID for multi-tenant data access

Query Parameters

​
page
integer
default:1
​
limit
integer
default:20
​
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

200

Paginated pledges