List sponsorship lifecycle history

GET

admin

sponsorships

lifecycle

events

List sponsorship lifecycle history

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

import requests

url = "https://api.gratona.com/v1/admin/sponsorships/lifecycle/events"

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/sponsorships/lifecycle/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/sponsorships/lifecycle/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/sponsorships/lifecycle/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/sponsorships/lifecycle/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,
      "subject_type": "recipient",
      "subject_id": 42,
      "correlation_id": "Example",
      "aggregate_version": 42,
      "donor_entity_id": 42,
      "donor_id": 42,
      "from_entity_id": 42,
      "entity_id": 42,
      "from_program_id": 42,
      "program_id": 42,
      "reason_definition_id": 42,
      "actor_user_id": 42,
      "donor_name": "Example",
      "from_recipient_name": "Example",
      "recipient_name": "Example",
      "from_program_name": "Example",
      "program_name": "Example",
      "reason_code": "Example",
      "reason_label": "Example",
      "notes": "Example",
      "currency": "Example",
      "actor_name": "Example",
      "source": "Example",
      "transition_type": "started",
      "reason_context_key": "recipient.archive",
      "amount": "25.00",
      "metadata": {
        "recipient_started_at": "2026-10-20T12:00:00Z",
        "from_recipient_started_at": "2026-10-20T12:00:00Z",
        "commitment_id": 42,
        "frequency": 42,
        "method": 42,
        "request_fingerprint": "sha256-hash",
        "payment_continuity_confirmed": false,
        "affected_sponsorship_count": 42,
        "recipient_exit_event_id": 42
      },
      "effective_at": "2026-10-20T12:00:00Z",
      "created_at": "2026-10-20T12:00:00Z",
      "delivery": {
        "status": "pending",
        "attempts": 0,
        "processed_at": "2026-10-20T12:00:00Z"
      }
    }
  ],
  "current_page": 42,
  "from": 42,
  "to": 42,
  "last_page": 42,
  "per_page": 42,
  "total": 12,
  "first_page_url": "Example",
  "last_page_url": "Example",
  "next_page_url": "Example",
  "prev_page_url": "Example",
  "path": "Example",
  "links": [
    {
      "url": "Example",
      "label": "1",
      "active": false
    }
  ]
}

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

{
  "message": "Not Found",
  "status": "error"
}

{
  "errors": {},
  "status": "error",
  "message": "The given data was invalid."
}

Authorizations

Authorization

string

header

required

Passport bearer token authentication for legacy admin sessions.

Query Parameters

donor_entity_id

integer | null

Match donor entity id. Entity/program match either prior or new side.

Required range: x >= 1

Example:

42

donor_id

integer | null

Match donor id. Entity/program match either prior or new side.

Required range: x >= 1

Example:

42

entity_id

integer | null

Match entity id. Entity/program match either prior or new side.

Required range: x >= 1

Example:

42

program_id

integer | null

Match program id. Entity/program match either prior or new side.

Required range: x >= 1

Example:

42

transition_type

enum<string> | null

Lifecycle event transition, including historical compatibility values.

Available options:

started,

reassigned,

transferred,

cancelled,

ended,

recipient_exited,

recipient_archived,

restored,

null

Example:

"started"

reason_context_key

enum<string> | null

Reason context; system is immutable lifecycle history.

Available options:

recipient.archive,

sponsorship.end,

sponsorship.reassign,

system,

null

Example:

"recipient.archive"

reason_code

string | null

Exact stable reason code.

Maximum string length: 100

Example:

"donor_cancelled"

date_from

string<date> | null

Effective date beginning, inclusive.

Example:

"2026-01-01"

date_to

string<date> | null

Effective date ending, inclusive; on or after date_from.

Example:

"2026-12-31"

per_page

integer | null

List page length, default25. Accepted but unused by summary.

Required range: 1 <= x <= 100

Example:

25

page

integer

One-based list page.

Example:

1

Response

List sponsorship lifecycle history completed.

data

object[]

Show child attributes

current_page

integer

One-based page.

Example:

42

from

integer | null

First row offset.

Example:

42

integer | null

Last row offset.

Example:

42

last_page

integer

Last page.

Example:

42

per_page

integer

Maximum rows per page.

Example:

42

total

integer

Total matching rows.

Example:

12

first_page_url

string | null

Paginator first page url.

Example:

"Example"

last_page_url

string | null

Paginator last page url.

Example:

"Example"

next_page_url

string | null

Paginator next page url.

Example:

"Example"

prev_page_url

string | null

Paginator prev page url.

Example:

"Example"

path

string | null

Paginator path.

Example:

"Example"

links

object[]

Show child attributes

List sponsorship lifecycle history

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

import requests

url = "https://api.gratona.com/v1/admin/sponsorships/lifecycle/events"

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/sponsorships/lifecycle/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/sponsorships/lifecycle/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/sponsorships/lifecycle/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/sponsorships/lifecycle/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,
      "subject_type": "recipient",
      "subject_id": 42,
      "correlation_id": "Example",
      "aggregate_version": 42,
      "donor_entity_id": 42,
      "donor_id": 42,
      "from_entity_id": 42,
      "entity_id": 42,
      "from_program_id": 42,
      "program_id": 42,
      "reason_definition_id": 42,
      "actor_user_id": 42,
      "donor_name": "Example",
      "from_recipient_name": "Example",
      "recipient_name": "Example",
      "from_program_name": "Example",
      "program_name": "Example",
      "reason_code": "Example",
      "reason_label": "Example",
      "notes": "Example",
      "currency": "Example",
      "actor_name": "Example",
      "source": "Example",
      "transition_type": "started",
      "reason_context_key": "recipient.archive",
      "amount": "25.00",
      "metadata": {
        "recipient_started_at": "2026-10-20T12:00:00Z",
        "from_recipient_started_at": "2026-10-20T12:00:00Z",
        "commitment_id": 42,
        "frequency": 42,
        "method": 42,
        "request_fingerprint": "sha256-hash",
        "payment_continuity_confirmed": false,
        "affected_sponsorship_count": 42,
        "recipient_exit_event_id": 42
      },
      "effective_at": "2026-10-20T12:00:00Z",
      "created_at": "2026-10-20T12:00:00Z",
      "delivery": {
        "status": "pending",
        "attempts": 0,
        "processed_at": "2026-10-20T12:00:00Z"
      }
    }
  ],
  "current_page": 42,
  "from": 42,
  "to": 42,
  "last_page": 42,
  "per_page": 42,
  "total": 12,
  "first_page_url": "Example",
  "last_page_url": "Example",
  "next_page_url": "Example",
  "prev_page_url": "Example",
  "path": "Example",
  "links": [
    {
      "url": "Example",
      "label": "1",
      "active": false
    }
  ]
}

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

{
  "message": "Not Found",
  "status": "error"
}

{
  "errors": {},
  "status": "error",
  "message": "The given data was invalid."
}