List all donations in a nation
Changed onLists all donations
Request
- Base URLhttps://yournation.nationbuilder.com
- AuthHTTP bearer
Query parameters
Page number to list (starting at 1)
Number of results to display per page (default: 20, max: 100, min: 1)
Response
A page of matching donations.
Example response
{
"data": [
{
"id": "1",
"type": "donations",
"attributes": {
"actblue_order_number": "123abc",
"amount_in_cents": 500,
"canceled_at": "2019-10-26T10:00:00-04:00",
"check_number": "1001",
"custom_values": {
"custom_text": "Text Value",
"custom_number": "22",
"custom_checkbox": true,
"custom_multi": "Some multiple choice option"
},
"donation_tracking_code_id": "1",
"email": "donor@gmail.com",
"employer": "Wild Horse Co.",
"external_id": "ext-123",
"failed_at": "2019-10-26T10:00:00-04:00",
"first_name": "Lucy",
"last_name": "Butler",
"mailing_id": "1",
"membership_id": "1",
"middle_name": "Octavia",
"note": "Dedicated to Lucy",
"occupation": "Postal Carrier",
"page_id": "1",
"payment_type_id": "1",
"payment_type_name": "Cash",
"pending_at": "2019-10-26T10:00:00-04:00",
"pledge_id": "1",
"recurring_donation_id": "1",
"signup_id": "1",
"succeeded_at": "2019-10-26T10:00:00-04:00",
"amount": "5.00",
"created_at": "2019-10-26T10:00:00-04:00",
"import_id": "1",
"payout_id": "po_abc123",
"status": "succeeded",
"updated_at": "2019-10-26T10:00:00-04:00"
}
}
],
"links": {
"self": "/articles?page[number]=2",
"first": "/articles?page[number]=1",
"last": "/articles?page[number]=5",
"prev": "/articles?page[number]=1",
"next": "/articles?page[number]=3"
},
"included": [
{
"id": "1"
}
]
}Changes
- breaking
for the
queryrequest parameterpage[number], default value1was added - breaking
for the
queryrequest parameterpage[size], default value20was added - breaking
the response's body type changed from
objectto no type for status - breaking
removed the required property
from the response with the status - warning
removed the optional property
from the response with the status - info
added the new optional
queryrequest parameterextra_fields[donations]to all path's operations - info
added
subschema #2to the response bodyallOflist for the response status - info
media type
application/jsonwas changed to a more specific media typeapplication/vnd.api+jsonfor the response status - info
added the non-success response with the status
- info
added the non-success response with the status
- breaking
- warning
removed the optional property
///////from the response with the status - info
added the optional property
///////to the response with the status - info
added the optional property
///////to the response with the status - info
added the optional property
///////to the response with the status
- warning