Commitments

Flat list of entities available for commitment picking

Returns permission-scoped recipient options for the authenticated client. Tenant and program filters are applied before pagination, and profile fields/uploads are hydrated only for the requested page. Available recipients have status 0 or 2. Each option includes program context, an optional profile image URL (thumbnail preferred, original image used while the thumbnail is unavailable), and up to three configured sponsorship-card fields. Requires permission: manage_programs.

GET

admin

list_available_entities

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

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

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

	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/list_available_entities")

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

[
  {
    "id": 789,
    "name": "Maria Lopez",
    "program_id": 17,
    "program_name": "Child Sponsorship",
    "status": 0,
    "thumbnail_url": "https://cdn.example.org/recipients/maria_t_.jpg",
    "featured_fields": [
      {}
    ],
    "unavailable_for_donor_entity_ids": [
      123
    ]
  }
]

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

Authorizations

Authorization

string

header

required

Passport bearer token authentication for legacy admin sessions.

Query Parameters

donor_entity_ids[]

integer[]

Current sponsorship relationship IDs. When supplied, each option identifies the relationships for which the recipient is unavailable because the same donor already sponsors them.

string

Recipient name/profile search applied in the database before hydration.

Maximum string length: 255

page

integer

default:1

One-based result page.

Required range: x >= 1

limit

integer

default:50

Maximum options per page.

Required range: 1 <= x <= 50

entity_id

integer

Resolve one exact recipient while retaining tenant and program permission scope.

Required range: x >= 1

paginated

boolean

default:false

When true, wraps options in data and includes page/per_page/has_more metadata. Omit for the legacy flat-array response.

Response

Available recipient options. Paginated requests return {data, meta}; legacy requests return the flat data array.

integer

Example:

789

name

string

Example:

"Maria Lopez"

program_id

integer

Example:

17

program_name

string

Example:

"Child Sponsorship"

status

integer

Example:

0

thumbnail_url

string<uri> | null

Display-ready profile image URL. Uses the thumbnail when available and otherwise falls back to the original image.

Example:

"https://cdn.example.org/recipients/maria_t_.jpg"

featured_fields

object[]

unavailable_for_donor_entity_ids

integer[]

Requested sponsorship relationship IDs that cannot move to this recipient because their donor already has an active relationship with the recipient.

Flat list of entities available for commitment picking

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

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

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

	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/list_available_entities")

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

[
  {
    "id": 789,
    "name": "Maria Lopez",
    "program_id": 17,
    "program_name": "Child Sponsorship",
    "status": 0,
    "thumbnail_url": "https://cdn.example.org/recipients/maria_t_.jpg",
    "featured_fields": [
      {}
    ],
    "unavailable_for_donor_entity_ids": [
      123
    ]
  }
]

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