List events - Gratona Docs

GET

admin

events

List events

curl --request GET \
  --url https://api.gratona.com/v1/admin/events \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.gratona.com/v1/admin/events', 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",
  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"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.gratona.com/v1/admin/events")

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": [
    {
      "id": 42,
      "registered_attendee_count": 42,
      "checked_in_count": 42,
      "completed_order_count": 42,
      "name": "Example",
      "slug": "Example",
      "type": "Example",
      "status": "Example",
      "timezone": "Example",
      "location_name": "Example",
      "starts_at": "2026-10-20T12:00:00Z",
      "ends_at": "2026-10-20T12:00:00Z",
      "created_at": "2026-10-20T12:00:00Z"
    }
  ],
  "meta": {
    "current_page": 42,
    "last_page": 42,
    "per_page": 42,
    "total": 42
  },
  "summary": {
    "total": 42,
    "upcoming": 42,
    "active": 42,
    "draft": 42,
    "registered": 42,
    "checked_in": 42,
    "completed_orders": 42,
    "next_event": {
      "id": 42,
      "name": "Annual Gala",
      "starts_at": "2026-10-20T12:00:00Z",
      "timezone": "Africa/Kampala"
    }
  }
}

{
  "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

Authorization

string

header

required

Passport bearer token authentication for legacy admin sessions.

Query Parameters

page

integer

One-based page.

Required range: x >= 1

Example:

1

per_page

integer

Rows per page; clamped to 1–100.

Required range: 1 <= x <= 100

Example:

20

view

enum<string>

Lifecycle view; default all.

Available options:

all,

upcoming,

active,

draft,

past,

archived

Example:

"all"

status

string

Exact status filter.

Example:

"registration_open"

string

Search name, slug, location, type and status.

Example:

"gala"

sort

string

name, starts_at, status or created_at; prefix minus for descending. Unknown values fall back to -created_at.

Example:

"-created_at"

include_summary

boolean

Add organization-wide summary counts.

Example:

false

Response

List events completed.

data

object[]

Show child attributes

meta

object

Show child attributes

summary

object

Show child attributes

List events

curl --request GET \
  --url https://api.gratona.com/v1/admin/events \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.gratona.com/v1/admin/events', 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",
  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"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.gratona.com/v1/admin/events")

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": [
    {
      "id": 42,
      "registered_attendee_count": 42,
      "checked_in_count": 42,
      "completed_order_count": 42,
      "name": "Example",
      "slug": "Example",
      "type": "Example",
      "status": "Example",
      "timezone": "Example",
      "location_name": "Example",
      "starts_at": "2026-10-20T12:00:00Z",
      "ends_at": "2026-10-20T12:00:00Z",
      "created_at": "2026-10-20T12:00:00Z"
    }
  ],
  "meta": {
    "current_page": 42,
    "last_page": 42,
    "per_page": 42,
    "total": 42
  },
  "summary": {
    "total": 42,
    "upcoming": 42,
    "active": 42,
    "draft": 42,
    "registered": 42,
    "checked_in": 42,
    "completed_orders": 42,
    "next_event": {
      "id": 42,
      "name": "Annual Gala",
      "starts_at": "2026-10-20T12:00:00Z",
      "timezone": "Africa/Kampala"
    }
  }
}

{
  "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"
}