List updated commitments for Zapier

GET

zapier

triggers

commitments

feed

List updated commitments for Zapier

curl --request GET \
  --url https://api.gratona.com/v3/zapier/triggers/commitments/feed \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.gratona.com/v3/zapier/triggers/commitments/feed"

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/v3/zapier/triggers/commitments/feed', 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/v3/zapier/triggers/commitments/feed",
  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/v3/zapier/triggers/commitments/feed"

	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/v3/zapier/triggers/commitments/feed")

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": "commitment-12345-2026-10-20T10:00:00Z",
      "commitment_id": 12345,
      "sponsorship_id": 12345,
      "donor_entity_id": 12345,
      "donor_id": 12345,
      "donor_form_id": 12345,
      "program_id": 11,
      "recipient_id": 4711,
      "fund_id": 12345,
      "designation_id": 12345,
      "type": 12345,
      "frequency": 12345,
      "frequency_id": 1,
      "method": 1,
      "method_id": 12345,
      "program_name": "example",
      "recipient_name": "example",
      "fund_name": "example",
      "designation_name": "example",
      "designation_type": "example",
      "amount_basis": "example",
      "frequency_label": "example",
      "method_label": "example",
      "until": "2027-11-01",
      "last": "example",
      "first_payment_date": "example",
      "next_payment_date": "2026-11-01",
      "last_payment_date": "example",
      "paid_through_date": "example",
      "status": "active",
      "amount": 25,
      "charge_amount": 25,
      "monthly_equivalent_amount": 25,
      "last_payment_amount": 25,
      "is_per_period_amount": false,
      "is_recurring": false,
      "is_non_charging": false,
      "funding": false,
      "archived": false,
      "designation": 4711,
      "donor": {
        "id": 12345,
        "hysform_id": 42,
        "display_name": "example",
        "email": "jane@example.org",
        "username": "jane.doe",
        "fields": "<unknown>"
      },
      "designation_details": {
        "id": 12345,
        "program_id": 11,
        "status": 12345,
        "display_name": "example",
        "email": "jane@example.org",
        "type": "individual",
        "fields": "<unknown>"
      },
      "recipient": {
        "id": 12345,
        "program_id": 11,
        "status": 12345,
        "display_name": "example",
        "email": "jane@example.org",
        "type": "individual",
        "fields": "<unknown>"
      },
      "fund": {
        "id": 12345,
        "program_id": 11,
        "status": 12345,
        "display_name": "example",
        "email": "jane@example.org",
        "type": "individual",
        "fields": "<unknown>"
      },
      "created_at": "2026-10-20T10:00:00Z",
      "updated_at": "2026-10-20T10:00:00Z"
    }
  ],
  "meta": {
    "page_size": 100,
    "has_more": false,
    "updated_after": "2026-10-01T00:00:00Z",
    "next_cursor": {
      "updated_at": "2026-10-19T14:00:00Z",
      "id": 12345
    }
  }
}

{
  "message": "Unauthorized",
  "status": "error"
}

{
  "success": false,
  "errors": [
    {
      "code": "INSUFFICIENT_SCOPE",
      "message": "Required scope is missing.",
      "required_scope": "schema:read",
      "available_scopes": [
        "<string>"
      ],
      "required_permission_groups": [
        [
          "<string>"
        ]
      ]
    }
  ]
}

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

Authorizations

Authorization

string

header

required

Passport bearer token authentication for legacy admin sessions.

Query Parameters

page_size

integer | null

Page size; defaults to100 and is capped at100. Validation: nullable|integer|min:1|max:100. Page size. Validation: nullable|integer|min:1|max:100.

Required range: 1 <= x <= 100

Example:

1

updated_after

string<date-time> | null

Lower updated_at bound; defaults to the start of the day90days before the request. Validation: nullable|date. Updated after. Validation: nullable|date.

cursor_updated_at

string<date-time> | null

Pass meta.next_cursor.updated_at when requesting the next page. Validation: nullable|date. Cursor updated at. Validation: nullable|date.

cursor_id

integer | null

Pass meta.next_cursor.id as the timestamp tie-breaker. Validation: nullable|integer|min:1. Cursor id. Validation: nullable|integer|min:1.

Required range: x >= 1

Example:

1

hysform_id

integer | null

Restrict to the donor profile form. Validation: nullable|integer. Donor form containing the profile. Validation: nullable|integer.

Example:

42

program_id

integer | null

Restrict to the recipient or sponsorship program. Validation: nullable|integer. Program containing the recipient or sponsorship. Validation: nullable|integer.

Example:

11

donor_id

integer | null

Restrict transactions or commitments to the donor. Validation: nullable|integer. Donor who owns the gift or commitment. Validation: nullable|integer.

Example:

12345

status

enum<string> | null

Requested active or archived lifecycle state. Validation: nullable|string|in:active,archived.

Available options:

active,

archived,

null

Example:

"active"

Response

Cursor page.

data

object[]

Changed records ordered by updated_at descending, then id descending.

Show child attributes

meta

object

Show child attributes

List updated commitments for Zapier

curl --request GET \
  --url https://api.gratona.com/v3/zapier/triggers/commitments/feed \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.gratona.com/v3/zapier/triggers/commitments/feed"

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/v3/zapier/triggers/commitments/feed', 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/v3/zapier/triggers/commitments/feed",
  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/v3/zapier/triggers/commitments/feed"

	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/v3/zapier/triggers/commitments/feed")

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": "commitment-12345-2026-10-20T10:00:00Z",
      "commitment_id": 12345,
      "sponsorship_id": 12345,
      "donor_entity_id": 12345,
      "donor_id": 12345,
      "donor_form_id": 12345,
      "program_id": 11,
      "recipient_id": 4711,
      "fund_id": 12345,
      "designation_id": 12345,
      "type": 12345,
      "frequency": 12345,
      "frequency_id": 1,
      "method": 1,
      "method_id": 12345,
      "program_name": "example",
      "recipient_name": "example",
      "fund_name": "example",
      "designation_name": "example",
      "designation_type": "example",
      "amount_basis": "example",
      "frequency_label": "example",
      "method_label": "example",
      "until": "2027-11-01",
      "last": "example",
      "first_payment_date": "example",
      "next_payment_date": "2026-11-01",
      "last_payment_date": "example",
      "paid_through_date": "example",
      "status": "active",
      "amount": 25,
      "charge_amount": 25,
      "monthly_equivalent_amount": 25,
      "last_payment_amount": 25,
      "is_per_period_amount": false,
      "is_recurring": false,
      "is_non_charging": false,
      "funding": false,
      "archived": false,
      "designation": 4711,
      "donor": {
        "id": 12345,
        "hysform_id": 42,
        "display_name": "example",
        "email": "jane@example.org",
        "username": "jane.doe",
        "fields": "<unknown>"
      },
      "designation_details": {
        "id": 12345,
        "program_id": 11,
        "status": 12345,
        "display_name": "example",
        "email": "jane@example.org",
        "type": "individual",
        "fields": "<unknown>"
      },
      "recipient": {
        "id": 12345,
        "program_id": 11,
        "status": 12345,
        "display_name": "example",
        "email": "jane@example.org",
        "type": "individual",
        "fields": "<unknown>"
      },
      "fund": {
        "id": 12345,
        "program_id": 11,
        "status": 12345,
        "display_name": "example",
        "email": "jane@example.org",
        "type": "individual",
        "fields": "<unknown>"
      },
      "created_at": "2026-10-20T10:00:00Z",
      "updated_at": "2026-10-20T10:00:00Z"
    }
  ],
  "meta": {
    "page_size": 100,
    "has_more": false,
    "updated_after": "2026-10-01T00:00:00Z",
    "next_cursor": {
      "updated_at": "2026-10-19T14:00:00Z",
      "id": 12345
    }
  }
}

{
  "message": "Unauthorized",
  "status": "error"
}

{
  "success": false,
  "errors": [
    {
      "code": "INSUFFICIENT_SCOPE",
      "message": "Required scope is missing.",
      "required_scope": "schema:read",
      "available_scopes": [
        "<string>"
      ],
      "required_permission_groups": [
        [
          "<string>"
        ]
      ]
    }
  ]
}

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