Events
Get event setup selectors
Returns event settings, programs/campaigns, up to 250 trips and designations, up to 500 recipient-group records, 50 cover images and 500 email templates. section=email_templates returns only the email template list. Sample trip-linked records are excluded. Requires event-view permission or a route-authorized Events role.
GET
/
admin
/
events
/
setup-options
Get event setup selectors
curl --request GET \
--url https://api.gratona.com/v1/admin/events/setup-options \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.gratona.com/v1/admin/events/setup-options"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.gratona.com/v1/admin/events/setup-options', 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/events/setup-options",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.gratona.com/v1/admin/events/setup-options"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.gratona.com/v1/admin/events/setup-options")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/events/setup-options")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"event_settings": [
{
"id": 42,
"value": "42",
"label": "Annual Gala",
"name": "Example",
"program_settings": "{`program_type`:`events`}"
}
],
"programs": [
{
"id": 42,
"value": "42",
"label": "Annual Gala",
"name": "Example",
"type": "Example",
"program_type": "Example",
"setting_id": 42
}
],
"campaigns": [
{
"id": 42,
"value": "42",
"label": "Annual Gala",
"name": "Example",
"type": "Example",
"program_type": "Example",
"setting_id": 42
}
],
"trips": [
{
"id": 42,
"value": "42",
"label": "Annual Gala",
"name": "Example",
"destination": "Example",
"status": "active"
}
],
"designations": [
{
"id": 42,
"value": "42",
"label": "Annual Gala",
"name": "Example",
"program_id": 42
}
],
"recipient_groups": [
{
"id": 42,
"value": "42",
"label": "Annual Gala",
"name": "Example",
"program_id": 42
}
],
"cover_images": [
{
"id": 42,
"label": "cover.jpg",
"url": "https://example.org/cover.jpg",
"thumbnail_url": "https://example.org/cover-thumb.jpg"
}
],
"email_templates": [
{
"id": 42,
"value": "42",
"label": "Annual Gala",
"name": "Example",
"subject": "Example",
"trigger": "new_donor",
"emailset_id": 42,
"donation_type": "default"
}
]
}
}{
"message": "Something went wrong. Please try again.",
"status": "error",
"error": "invalid_request",
"code": "DONOR_NOT_FOUND"
}{
"message": "Something went wrong. Please try again.",
"status": "error",
"error": "invalid_request",
"code": "DONOR_NOT_FOUND"
}Authorizations
bearerAuthapiKeyAuth
Passport bearer token authentication for legacy admin sessions.
Query Parameters
Use email_templates for only email-template choices.
Example:
"email_templates"
Response
Get event setup selectors completed.
Show child attributes
Show child attributes
⌘I
Get event setup selectors
curl --request GET \
--url https://api.gratona.com/v1/admin/events/setup-options \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.gratona.com/v1/admin/events/setup-options"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.gratona.com/v1/admin/events/setup-options', 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/events/setup-options",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.gratona.com/v1/admin/events/setup-options"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.gratona.com/v1/admin/events/setup-options")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/events/setup-options")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"event_settings": [
{
"id": 42,
"value": "42",
"label": "Annual Gala",
"name": "Example",
"program_settings": "{`program_type`:`events`}"
}
],
"programs": [
{
"id": 42,
"value": "42",
"label": "Annual Gala",
"name": "Example",
"type": "Example",
"program_type": "Example",
"setting_id": 42
}
],
"campaigns": [
{
"id": 42,
"value": "42",
"label": "Annual Gala",
"name": "Example",
"type": "Example",
"program_type": "Example",
"setting_id": 42
}
],
"trips": [
{
"id": 42,
"value": "42",
"label": "Annual Gala",
"name": "Example",
"destination": "Example",
"status": "active"
}
],
"designations": [
{
"id": 42,
"value": "42",
"label": "Annual Gala",
"name": "Example",
"program_id": 42
}
],
"recipient_groups": [
{
"id": 42,
"value": "42",
"label": "Annual Gala",
"name": "Example",
"program_id": 42
}
],
"cover_images": [
{
"id": 42,
"label": "cover.jpg",
"url": "https://example.org/cover.jpg",
"thumbnail_url": "https://example.org/cover-thumb.jpg"
}
],
"email_templates": [
{
"id": 42,
"value": "42",
"label": "Annual Gala",
"name": "Example",
"subject": "Example",
"trigger": "new_donor",
"emailset_id": 42,
"donation_type": "default"
}
]
}
}{
"message": "Something went wrong. Please try again.",
"status": "error",
"error": "invalid_request",
"code": "DONOR_NOT_FOUND"
}{
"message": "Something went wrong. Please try again.",
"status": "error",
"error": "invalid_request",
"code": "DONOR_NOT_FOUND"
}