Skip to main content
GET
/
history
Get donation history
curl --request GET \
  --url https://api.example.com/history
{
  "content": [
    {
      "id": "<string>",
      "type": "<string>",
      "recipientId": "<string>",
      "system": "<string>",
      "originId": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "nickname": "<string>",
      "amount": {
        "minor": 123,
        "major": 123,
        "currency": "<string>"
      },
      "message": "<string>",
      "attachments": [
        {
          "id": "<string>",
          "url": "<string>",
          "title": "<string>",
          "thumbnail": "<string>"
        }
      ],
      "goals": [
        {
          "goalId": "<string>",
          "goalTitle": "<string>"
        }
      ],
      "reelResults": [
        {
          "title": "<string>"
        }
      ],
      "actions": [
        {
          "id": "<string>",
          "actionId": "<string>",
          "name": "<string>",
          "amount": 123,
          "payload": {}
        }
      ],
      "vote": {
        "id": "<string>",
        "name": "<string>",
        "isNew": true
      },
      "alerts": [
        {
          "id": "<string>",
          "shownAt": "2023-11-07T05:31:56Z"
        }
      ],
      "level": 123,
      "count": 123,
      "levelName": "<string>"
    }
  ],
  "pageable": {
    "orderBy": [
      {
        "ignoreCase": true,
        "property": "<string>",
        "ascending": true
      }
    ],
    "size": 123,
    "sort": {
      "orderBy": [
        {
          "ignoreCase": true,
          "property": "<string>",
          "ascending": true
        }
      ]
    },
    "number": 123
  },
  "pageNumber": 123,
  "offset": 123,
  "size": 123,
  "empty": true,
  "numberOfElements": 123,
  "totalSize": 123,
  "totalPages": 123
}

Query Parameters

​
page
integer<int32>

Zero-indexed page number (0-based)

Required range: x >= 0
Example:

0

​
size
integer<int32>

Number of items per page

​
sort
string

Sorting criteria in format: property,asc|desc

​
systems
string[] | null
​
events
string[] | null
​
after
string<date-time> | null
​
before
string<date-time> | null

Response

Successfully retrieved history items

​
content
object[]
required
​
pageable
object
required
​
pageNumber
integer<int32>
​
offset
integer<int64>
​
size
integer<int32>
​
empty
boolean
​
numberOfElements
integer<int32>
​
totalSize
integer<int64>
​
totalPages
integer<int32>