Programs

Get organization-scoped campaign checkout metadata

Public campaign/program form metadata scoped by both organization and program. entity_mode=search returns only recipient options and paging metadata; initial returns bounded options with full form/configuration metadata, optionally adding a selected recipient beyond the limit; none omits recipients; options returns all projected options; full (and unknown modes) returns all raw recipient records. The search limit is clamped1–50, default24. trip_id can select a matching trip donor form. Standard donor field and public donation field contracts are returned only when their features/policies permit. Program progress is cached for30seconds. This metadata request does not create a donor or payment.

GET

frontend

program

{client_id}

{program_id}

campaign

Get organization-scoped campaign checkout metadata

curl --request GET \
  --url https://api.gratona.com/v1/frontend/program/{client_id}/{program_id}/campaign

const options = {method: 'GET'};

fetch('https://api.gratona.com/v1/frontend/program/{client_id}/{program_id}/campaign', 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/frontend/program/{client_id}/{program_id}/campaign",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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/frontend/program/{client_id}/{program_id}/campaign"

	req, _ := http.NewRequest("GET", url, nil)

	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/frontend/program/{client_id}/{program_id}/campaign")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "program": [
    {
      "id": 11,
      "client_id": 207,
      "name": "Child Sponsorship 2026",
      "type": "Contribution",
      "prefix": "CS-2026",
      "link_id": null,
      "hysform_id": 42,
      "donor_hysform_id": 43,
      "setting_id": 87,
      "emailset_id": 14,
      "smsset_id": null,
      "lft": 1,
      "rgt": 8,
      "tree": 1,
      "created_at": "2025-01-01T00:00:00Z",
      "updated_at": "2025-12-31T23:00:00Z",
      "deleted_at": null
    }
  ],
  "signup_fields": [
    {
      "field_key": "first_name",
      "field_label": "First name",
      "field_type": "hysText",
      "field_data": "<string>",
      "permissions": "public",
      "required": "<unknown>"
    }
  ],
  "entities": [
    {
      "id": 42,
      "program_id": 12,
      "entity_name": {
        "id": 42,
        "name": "Education fund",
        "program_id": 12
      },
      "is_featured": false,
      "designation_bio": null,
      "profilePic": "<string>",
      "profileThumb": "<string>",
      "profile_image": "<string>",
      "json_fields": "<unknown>"
    }
  ],
  "program_progress": {
    "program": {
      "name": "Education"
    },
    "total_amount": 5000,
    "donation_count": 12,
    "settings": {},
    "currency": "$"
  },
  "donation_fields": [
    {
      "field_key": "<string>",
      "field_label": "<string>",
      "field_type": "<string>",
      "field_data": "<string>",
      "permissions": "public",
      "field_order": 123,
      "required": "<unknown>",
      "conditional_display_rule": {}
    }
  ],
  "additional_gifts": [
    {
      "id": 123,
      "name": "<string>",
      "code": "<string>"
    }
  ],
  "entity_meta": {
    "mode": "initial",
    "total": 100,
    "limit": 24,
    "has_more": true,
    "search": "Education"
  },
  "client": {
    "id": 207,
    "organization": "Gratona Demo Org",
    "website": "https://demo.gratona.com",
    "email": "hello@demo.gratona.com",
    "stripe_connect_id": "acct_1OqXXXXX",
    "previous_stripe_connect_id": null,
    "completed_stripe_onboarding": true,
    "date_format": "Y-m-d",
    "timezone": "America/Chicago",
    "custom": {},
    "frequency": {},
    "custom_start_date": null,
    "custom_amount": null,
    "created_at": "2024-06-01T12:00:00Z",
    "updated_at": "2026-01-01T00:00:00Z"
  },
  "show_standardized_fields": true,
  "visible_standard_field_keys": [
    "<string>"
  ],
  "required_standard_field_keys": [
    "<string>"
  ],
  "standard_field_contract": {
    "version": 1,
    "policy_revision": "1:0",
    "fields": [
      {
        "key": "first_name",
        "label": "First name",
        "group": "identity",
        "applies_to": [
          "<string>"
        ],
        "presentation": "input",
        "source_keys": [
          "<string>"
        ]
      }
    ],
    "visible_input_keys": [
      "<string>"
    ],
    "required_input_keys": [
      "<string>"
    ],
    "visible_input_keys_by_donor_type": {},
    "required_input_keys_by_donor_type": {},
    "system_value_keys": [
      "<string>"
    ],
    "email_required": false,
    "email_requirement_reason": "<string>"
  },
  "meta_pixel": {
    "id": "<string>",
    "enabled": false,
    "currency_symbol": "$",
    "currency_code": "USD"
  }
}

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

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

Path Parameters

client_id

integer

required

Client id in the current organization.

program_id

integer

required

Program id in the current organization.

Query Parameters

entity_mode

enum<string>

Recipient payload mode.

Available options:

full,

options,

initial,

search,

none

entity_search

string

Recipient title search, trimmed and truncated to100characters.

Maximum string length: 100

entity_limit

integer

Initial/search page size, clamped1–50.

Required range: 1 <= x <= 50

selected_entity_id

integer

An initial selection to include when it belongs to this program.

Required range: x >= 0

trip_id

integer

Optional matching trip ID used to select its donor form.

Required range: x >= 0

Response

Operation result.

Option 1
Option 2

program

Program · object[]

required

HTTP contracts traced from the deployed controller and delegated validation/serialization.

Show child attributes

entities

object[]

required

Show child attributes

program_progress

object

required

Show child attributes

donation_fields

object[]

Show child attributes

additional_gifts

object[]

Show child attributes

entity_meta

object

Show child attributes

client

Client · object

A Gratona client — the tenant of the multi-tenant system. Owns donors, entities, programs, users, and integrations. The client_id on every other resource scopes data to this row. Stripe Connect onboarding state, account-level settings, and the client's display name all live here.

Show child attributes

show_standardized_fields

boolean

Example:

true

visible_standard_field_keys

string[]

required_standard_field_keys

string[]

standard_field_contract

object

Show child attributes

meta_pixel

object

Show child attributes

Get organization-scoped campaign checkout metadata

curl --request GET \
  --url https://api.gratona.com/v1/frontend/program/{client_id}/{program_id}/campaign

const options = {method: 'GET'};

fetch('https://api.gratona.com/v1/frontend/program/{client_id}/{program_id}/campaign', 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/frontend/program/{client_id}/{program_id}/campaign",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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/frontend/program/{client_id}/{program_id}/campaign"

	req, _ := http.NewRequest("GET", url, nil)

	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/frontend/program/{client_id}/{program_id}/campaign")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "program": [
    {
      "id": 11,
      "client_id": 207,
      "name": "Child Sponsorship 2026",
      "type": "Contribution",
      "prefix": "CS-2026",
      "link_id": null,
      "hysform_id": 42,
      "donor_hysform_id": 43,
      "setting_id": 87,
      "emailset_id": 14,
      "smsset_id": null,
      "lft": 1,
      "rgt": 8,
      "tree": 1,
      "created_at": "2025-01-01T00:00:00Z",
      "updated_at": "2025-12-31T23:00:00Z",
      "deleted_at": null
    }
  ],
  "signup_fields": [
    {
      "field_key": "first_name",
      "field_label": "First name",
      "field_type": "hysText",
      "field_data": "<string>",
      "permissions": "public",
      "required": "<unknown>"
    }
  ],
  "entities": [
    {
      "id": 42,
      "program_id": 12,
      "entity_name": {
        "id": 42,
        "name": "Education fund",
        "program_id": 12
      },
      "is_featured": false,
      "designation_bio": null,
      "profilePic": "<string>",
      "profileThumb": "<string>",
      "profile_image": "<string>",
      "json_fields": "<unknown>"
    }
  ],
  "program_progress": {
    "program": {
      "name": "Education"
    },
    "total_amount": 5000,
    "donation_count": 12,
    "settings": {},
    "currency": "$"
  },
  "donation_fields": [
    {
      "field_key": "<string>",
      "field_label": "<string>",
      "field_type": "<string>",
      "field_data": "<string>",
      "permissions": "public",
      "field_order": 123,
      "required": "<unknown>",
      "conditional_display_rule": {}
    }
  ],
  "additional_gifts": [
    {
      "id": 123,
      "name": "<string>",
      "code": "<string>"
    }
  ],
  "entity_meta": {
    "mode": "initial",
    "total": 100,
    "limit": 24,
    "has_more": true,
    "search": "Education"
  },
  "client": {
    "id": 207,
    "organization": "Gratona Demo Org",
    "website": "https://demo.gratona.com",
    "email": "hello@demo.gratona.com",
    "stripe_connect_id": "acct_1OqXXXXX",
    "previous_stripe_connect_id": null,
    "completed_stripe_onboarding": true,
    "date_format": "Y-m-d",
    "timezone": "America/Chicago",
    "custom": {},
    "frequency": {},
    "custom_start_date": null,
    "custom_amount": null,
    "created_at": "2024-06-01T12:00:00Z",
    "updated_at": "2026-01-01T00:00:00Z"
  },
  "show_standardized_fields": true,
  "visible_standard_field_keys": [
    "<string>"
  ],
  "required_standard_field_keys": [
    "<string>"
  ],
  "standard_field_contract": {
    "version": 1,
    "policy_revision": "1:0",
    "fields": [
      {
        "key": "first_name",
        "label": "First name",
        "group": "identity",
        "applies_to": [
          "<string>"
        ],
        "presentation": "input",
        "source_keys": [
          "<string>"
        ]
      }
    ],
    "visible_input_keys": [
      "<string>"
    ],
    "required_input_keys": [
      "<string>"
    ],
    "visible_input_keys_by_donor_type": {},
    "required_input_keys_by_donor_type": {},
    "system_value_keys": [
      "<string>"
    ],
    "email_required": false,
    "email_requirement_reason": "<string>"
  },
  "meta_pixel": {
    "id": "<string>",
    "enabled": false,
    "currency_symbol": "$",
    "currency_code": "USD"
  }
}

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

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