Skip to main content
POST
/
admin
/
donations
/
{all}
View all donations
curl --request POST \
  --url https://api.helpyousponsor.com/v1/admin/donations/{all} \
  --header 'Content-Type: application/json' \
  --header 'X-HYS-API-Key: <api-key>' \
  --data '
{
  "client_id": "1",
  "date_from": "2022-01-01",
  "date_to": "2022-12-31",
  "pageSize": 10,
  "pageIndex": 1
}
'
import requests

url = "https://api.helpyousponsor.com/v1/admin/donations/{all}"

payload = {
"client_id": "1",
"date_from": "2022-01-01",
"date_to": "2022-12-31",
"pageSize": 10,
"pageIndex": 1
}
headers = {
"X-HYS-API-Key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'X-HYS-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
client_id: '1',
date_from: '2022-01-01',
date_to: '2022-12-31',
pageSize: 10,
pageIndex: 1
})
};

fetch('https://api.helpyousponsor.com/v1/admin/donations/{all}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.helpyousponsor.com/v1/admin/donations/{all}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'client_id' => '1',
'date_from' => '2022-01-01',
'date_to' => '2022-12-31',
'pageSize' => 10,
'pageIndex' => 1
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-HYS-API-Key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.helpyousponsor.com/v1/admin/donations/{all}"

payload := strings.NewReader("{\n \"client_id\": \"1\",\n \"date_from\": \"2022-01-01\",\n \"date_to\": \"2022-12-31\",\n \"pageSize\": 10,\n \"pageIndex\": 1\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("X-HYS-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.helpyousponsor.com/v1/admin/donations/{all}")
.header("X-HYS-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"client_id\": \"1\",\n \"date_from\": \"2022-01-01\",\n \"date_to\": \"2022-12-31\",\n \"pageSize\": 10,\n \"pageIndex\": 1\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.helpyousponsor.com/v1/admin/donations/{all}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-HYS-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"client_id\": \"1\",\n \"date_from\": \"2022-01-01\",\n \"date_to\": \"2022-12-31\",\n \"pageSize\": 10,\n \"pageIndex\": 1\n}"

response = http.request(request)
puts response.read_body
{
  "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": {}
}
{
"message": "The given data was invalid",
"errors": {}
}

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