Donors
List fields and comparators available to the rule editor
Returns the union of system fields (email, username), standardized title fields (from DonorStandardFieldSetting), and form-specific title fields (Donorfield rows where is_title=1) — keyed by field_key and deduplicated. Also returns the supported comparator and field-type vocabularies so the admin UI can render rule pickers without hard-coding the choices. Requires permission: duplicates_manage (also satisfied by donors_manage).
GET
/
admin
/
donors
/
{hysform_id}
/
duplicates
/
field-types
List fields and comparators available to the rule editor
curl --request GET \
--url https://api.gratona.com/v1/admin/donors/{hysform_id}/duplicates/field-types \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.gratona.com/v1/admin/donors/{hysform_id}/duplicates/field-types"
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/donors/{hysform_id}/duplicates/field-types', 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/donors/{hysform_id}/duplicates/field-types",
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/donors/{hysform_id}/duplicates/field-types"
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))
}HttpResponse<String> response = Unirest.get("https://api.gratona.com/v1/admin/donors/{hysform_id}/duplicates/field-types")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/donors/{hysform_id}/duplicates/field-types")
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{
"success": true,
"data": {
"fields": [
{
"field_key": "email",
"field_label": "Email",
"field_type": "email"
}
],
"comparators": {
"exact": "Exact Match",
"normalized": "Normalized Match",
"fuzzy": "Fuzzy Match",
"phonetic": "Phonetic Match"
},
"field_types": {
"email": "Email Address",
"text": "Text",
"phone": "Phone Number",
"date": "Date",
"numeric": "Numeric"
}
}
}{
"message": "Unauthorized",
"status": "error"
}{
"success": false,
"message": "Failed to get field types",
"error": "<string>"
}Authorizations
bearerAuthapiKeyAuth
Passport bearer token authentication for legacy admin sessions.
Path Parameters
Donor form whose title fields to enumerate.
⌘I
List fields and comparators available to the rule editor
curl --request GET \
--url https://api.gratona.com/v1/admin/donors/{hysform_id}/duplicates/field-types \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.gratona.com/v1/admin/donors/{hysform_id}/duplicates/field-types"
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/donors/{hysform_id}/duplicates/field-types', 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/donors/{hysform_id}/duplicates/field-types",
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/donors/{hysform_id}/duplicates/field-types"
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))
}HttpResponse<String> response = Unirest.get("https://api.gratona.com/v1/admin/donors/{hysform_id}/duplicates/field-types")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/donors/{hysform_id}/duplicates/field-types")
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{
"success": true,
"data": {
"fields": [
{
"field_key": "email",
"field_label": "Email",
"field_type": "email"
}
],
"comparators": {
"exact": "Exact Match",
"normalized": "Normalized Match",
"fuzzy": "Fuzzy Match",
"phonetic": "Phonetic Match"
},
"field_types": {
"email": "Email Address",
"text": "Text",
"phone": "Phone Number",
"date": "Date",
"numeric": "Numeric"
}
}
}{
"message": "Unauthorized",
"status": "error"
}{
"success": false,
"message": "Failed to get field types",
"error": "<string>"
}