Skip to main content
POST
/
admin
/
donations
/
{all}
View all donations
curl --request POST \
  --url https://api.helpyousponsor.com/v1/admin/donations/{all} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "client_id": "1",
  "date_from": "2022-01-01",
  "date_to": "2022-12-31",
  "pageSize": 10,
  "pageIndex": 1
}'
{
  "donations": [
    {}
  ],
  "organization": "Organization Name",
  "number_of_allDonations": 100,
  "number_of_donations": 10,
  "total_of_donations": "1000",
  "donation_graph_data": [
    {}
  ],
  "fields": [
    {}
  ],
  "date_from": "2022-01-01",
  "date_to": "2022-12-31",
  "all": false,
  "hysform": {}
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
all
boolean
required

Flag to get all donations

Body

application/json

Data needed to view all donations

​
client_id
string
Example:

"1"

​
date_from
string<date>
Example:

"2022-01-01"

​
date_to
string<date>
Example:

"2022-12-31"

​
pageSize
integer
Example:

10

​
pageIndex
integer
Example:

1

Response

Successful operation

​
donations
object[]
​
organization
string
Example:

"Organization Name"

​
number_of_allDonations
integer
Example:

100

​
number_of_donations
integer
Example:

10

​
total_of_donations
string
Example:

"1000"

​
donation_graph_data
object[]
​
fields
object[]
​
date_from
string<date>
Example:

"2022-01-01"

​
date_to
string<date>
Example:

"2022-12-31"

​
all
boolean
Example:

false

​
hysform
object
⌘I