Skip to main content
POST
View all donations

Authorizations

X-HYS-API-Key
string
header
required

API key generated from Developer Settings. Format: hys_...

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