Queue a CSV export of sponsorships (async)
Preferred export endpoint for wide sponsorship worksheets. Accepts filters, column_order, and column_labels in a JSON request body, reserves an Upload row, marks it queued, and dispatches ExportSponsorshipsJob. Labels only rename columns already present in validated column_order; they cannot add columns. Requires permission: programs_view, manage_programs, or program-all.
curl --request POST \
--url https://api.gratona.com/v1/admin/sponsorships/{program_id}/export \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filter": false,
"query": "mateo",
"status": "current",
"savedFilterId": 77,
"fields": [
"en_child_name",
"dn_donor_name"
],
"column_order": [
"display_name",
"donor_name",
"amount"
],
"column_labels": {
"display_name": "Recipient Name",
"donor_name": "Donor Name"
},
"filterGroups": [
{
"field": "en_child_name",
"operator": "contains",
"value": "Mateo",
"logicalOperator": null
}
]
}
'import requests
url = "https://api.gratona.com/v1/admin/sponsorships/{program_id}/export"
payload = {
"filter": False,
"query": "mateo",
"status": "current",
"savedFilterId": 77,
"fields": ["en_child_name", "dn_donor_name"],
"column_order": ["display_name", "donor_name", "amount"],
"column_labels": {
"display_name": "Recipient Name",
"donor_name": "Donor Name"
},
"filterGroups": [
{
"field": "en_child_name",
"operator": "contains",
"value": "Mateo",
"logicalOperator": None
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
filter: false,
query: 'mateo',
status: 'current',
savedFilterId: 77,
fields: ['en_child_name', 'dn_donor_name'],
column_order: ['display_name', 'donor_name', 'amount'],
column_labels: {display_name: 'Recipient Name', donor_name: 'Donor Name'},
filterGroups: [
{
field: 'en_child_name',
operator: 'contains',
value: 'Mateo',
logicalOperator: null
}
]
})
};
fetch('https://api.gratona.com/v1/admin/sponsorships/{program_id}/export', 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.gratona.com/v1/admin/sponsorships/{program_id}/export",
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([
'filter' => false,
'query' => 'mateo',
'status' => 'current',
'savedFilterId' => 77,
'fields' => [
'en_child_name',
'dn_donor_name'
],
'column_order' => [
'display_name',
'donor_name',
'amount'
],
'column_labels' => [
'display_name' => 'Recipient Name',
'donor_name' => 'Donor Name'
],
'filterGroups' => [
[
'field' => 'en_child_name',
'operator' => 'contains',
'value' => 'Mateo',
'logicalOperator' => null
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.gratona.com/v1/admin/sponsorships/{program_id}/export"
payload := strings.NewReader("{\n \"filter\": false,\n \"query\": \"mateo\",\n \"status\": \"current\",\n \"savedFilterId\": 77,\n \"fields\": [\n \"en_child_name\",\n \"dn_donor_name\"\n ],\n \"column_order\": [\n \"display_name\",\n \"donor_name\",\n \"amount\"\n ],\n \"column_labels\": {\n \"display_name\": \"Recipient Name\",\n \"donor_name\": \"Donor Name\"\n },\n \"filterGroups\": [\n {\n \"field\": \"en_child_name\",\n \"operator\": \"contains\",\n \"value\": \"Mateo\",\n \"logicalOperator\": null\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.gratona.com/v1/admin/sponsorships/{program_id}/export")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"filter\": false,\n \"query\": \"mateo\",\n \"status\": \"current\",\n \"savedFilterId\": 77,\n \"fields\": [\n \"en_child_name\",\n \"dn_donor_name\"\n ],\n \"column_order\": [\n \"display_name\",\n \"donor_name\",\n \"amount\"\n ],\n \"column_labels\": {\n \"display_name\": \"Recipient Name\",\n \"donor_name\": \"Donor Name\"\n },\n \"filterGroups\": [\n {\n \"field\": \"en_child_name\",\n \"operator\": \"contains\",\n \"value\": \"Mateo\",\n \"logicalOperator\": null\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/sponsorships/{program_id}/export")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filter\": false,\n \"query\": \"mateo\",\n \"status\": \"current\",\n \"savedFilterId\": 77,\n \"fields\": [\n \"en_child_name\",\n \"dn_donor_name\"\n ],\n \"column_order\": [\n \"display_name\",\n \"donor_name\",\n \"amount\"\n ],\n \"column_labels\": {\n \"display_name\": \"Recipient Name\",\n \"donor_name\": \"Donor Name\"\n },\n \"filterGroups\": [\n {\n \"field\": \"en_child_name\",\n \"operator\": \"contains\",\n \"value\": \"Mateo\",\n \"logicalOperator\": null\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"message": "Export initiated successfully. You will get a notification in Activity when the CSV is ready to download.",
"status": "queued",
"export_id": 512,
"status_url": "/admin/sponsorships/exports/512/status"
}{
"message": "Unauthorized",
"status": "error"
}{
"message": "An error occurred while starting the export process. Please try again later."
}Authorizations
Passport bearer token authentication for legacy admin sessions.
Path Parameters
Program to export, or the literal string all.
Body
false
"mateo"
current, due "current"
77
["en_child_name", "dn_donor_name"]
Ordered export column keys. Synthetic identity keys such as display_name, recipient_name, and donor_name are valid export column keys.
["display_name", "donor_name", "amount"]
Optional key-to-label map, or a JSON-encoded map, for requested export columns. Labels only affect validated columns from column_order; they cannot add columns.
{
"display_name": "Recipient Name",
"donor_name": "Donor Name"
}
Show child attributes
Show child attributes
curl --request POST \
--url https://api.gratona.com/v1/admin/sponsorships/{program_id}/export \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filter": false,
"query": "mateo",
"status": "current",
"savedFilterId": 77,
"fields": [
"en_child_name",
"dn_donor_name"
],
"column_order": [
"display_name",
"donor_name",
"amount"
],
"column_labels": {
"display_name": "Recipient Name",
"donor_name": "Donor Name"
},
"filterGroups": [
{
"field": "en_child_name",
"operator": "contains",
"value": "Mateo",
"logicalOperator": null
}
]
}
'import requests
url = "https://api.gratona.com/v1/admin/sponsorships/{program_id}/export"
payload = {
"filter": False,
"query": "mateo",
"status": "current",
"savedFilterId": 77,
"fields": ["en_child_name", "dn_donor_name"],
"column_order": ["display_name", "donor_name", "amount"],
"column_labels": {
"display_name": "Recipient Name",
"donor_name": "Donor Name"
},
"filterGroups": [
{
"field": "en_child_name",
"operator": "contains",
"value": "Mateo",
"logicalOperator": None
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
filter: false,
query: 'mateo',
status: 'current',
savedFilterId: 77,
fields: ['en_child_name', 'dn_donor_name'],
column_order: ['display_name', 'donor_name', 'amount'],
column_labels: {display_name: 'Recipient Name', donor_name: 'Donor Name'},
filterGroups: [
{
field: 'en_child_name',
operator: 'contains',
value: 'Mateo',
logicalOperator: null
}
]
})
};
fetch('https://api.gratona.com/v1/admin/sponsorships/{program_id}/export', 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.gratona.com/v1/admin/sponsorships/{program_id}/export",
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([
'filter' => false,
'query' => 'mateo',
'status' => 'current',
'savedFilterId' => 77,
'fields' => [
'en_child_name',
'dn_donor_name'
],
'column_order' => [
'display_name',
'donor_name',
'amount'
],
'column_labels' => [
'display_name' => 'Recipient Name',
'donor_name' => 'Donor Name'
],
'filterGroups' => [
[
'field' => 'en_child_name',
'operator' => 'contains',
'value' => 'Mateo',
'logicalOperator' => null
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.gratona.com/v1/admin/sponsorships/{program_id}/export"
payload := strings.NewReader("{\n \"filter\": false,\n \"query\": \"mateo\",\n \"status\": \"current\",\n \"savedFilterId\": 77,\n \"fields\": [\n \"en_child_name\",\n \"dn_donor_name\"\n ],\n \"column_order\": [\n \"display_name\",\n \"donor_name\",\n \"amount\"\n ],\n \"column_labels\": {\n \"display_name\": \"Recipient Name\",\n \"donor_name\": \"Donor Name\"\n },\n \"filterGroups\": [\n {\n \"field\": \"en_child_name\",\n \"operator\": \"contains\",\n \"value\": \"Mateo\",\n \"logicalOperator\": null\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.gratona.com/v1/admin/sponsorships/{program_id}/export")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"filter\": false,\n \"query\": \"mateo\",\n \"status\": \"current\",\n \"savedFilterId\": 77,\n \"fields\": [\n \"en_child_name\",\n \"dn_donor_name\"\n ],\n \"column_order\": [\n \"display_name\",\n \"donor_name\",\n \"amount\"\n ],\n \"column_labels\": {\n \"display_name\": \"Recipient Name\",\n \"donor_name\": \"Donor Name\"\n },\n \"filterGroups\": [\n {\n \"field\": \"en_child_name\",\n \"operator\": \"contains\",\n \"value\": \"Mateo\",\n \"logicalOperator\": null\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/sponsorships/{program_id}/export")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filter\": false,\n \"query\": \"mateo\",\n \"status\": \"current\",\n \"savedFilterId\": 77,\n \"fields\": [\n \"en_child_name\",\n \"dn_donor_name\"\n ],\n \"column_order\": [\n \"display_name\",\n \"donor_name\",\n \"amount\"\n ],\n \"column_labels\": {\n \"display_name\": \"Recipient Name\",\n \"donor_name\": \"Donor Name\"\n },\n \"filterGroups\": [\n {\n \"field\": \"en_child_name\",\n \"operator\": \"contains\",\n \"value\": \"Mateo\",\n \"logicalOperator\": null\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"message": "Export initiated successfully. You will get a notification in Activity when the CSV is ready to download.",
"status": "queued",
"export_id": 512,
"status_url": "/admin/sponsorships/exports/512/status"
}{
"message": "Unauthorized",
"status": "error"
}{
"message": "An error occurred while starting the export process. Please try again later."
}