Read a recipient participation timeline
Requires the participation feature, programs_view and access to this organization-owned program. Requires participation_view, participation_record, participation_submit or participation_configure. Results follow the caller’s site/cohort scope. Requires visible placement or submitted/superseded/voided evidence within the caller’s scope for restricted roles. Includes archived recipients, scoped placement history and finalized evidence; draft observations are omitted. Scoped current state is reconstructed from permitted evidence and conceals program-wide follow-ups; unrestricted callers receive the rollup and any viewable open follow-up.
curl --request GET \
--url https://api.gratona.com/v1/admin/programs/{program_id}/participation/recipients/{entity_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.gratona.com/v1/admin/programs/{program_id}/participation/recipients/{entity_id}"
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/programs/{program_id}/participation/recipients/{entity_id}', 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/programs/{program_id}/participation/recipients/{entity_id}",
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/programs/{program_id}/participation/recipients/{entity_id}"
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/programs/{program_id}/participation/recipients/{entity_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/programs/{program_id}/participation/recipients/{entity_id}")
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{
"recipient": {
"id": 123,
"display_name": "<string>",
"is_visible": true,
"is_archived": true,
"profile_readiness": {
"ready": true,
"status": "ready",
"missing_keys": [
"<string>"
],
"missing_labels": [
"<string>"
]
}
},
"current": {
"site": "<string>",
"cohort": "<string>",
"enrollment_state": "<string>",
"last_verified_on": "2023-12-25",
"last_seen_on": "2023-12-25",
"evidence_source": "<string>",
"consecutive_unresolved_checks": 123,
"unresolved_since": "2023-12-25",
"follow_up": {
"id": 123,
"title": "<string>",
"status": "<string>",
"due_date": "2023-12-25"
}
},
"placements": [
{
"id": 123,
"site": "<string>",
"cohort": "<string>",
"state": "<string>",
"started_on": "2023-12-25",
"ended_on": "2023-12-25",
"current": true,
"source": "<string>",
"recorded_at": "2023-11-07T05:31:56Z",
"source_session_id": 123,
"revision": 123,
"reason_code": "<string>",
"note": "<string>",
"operator": {
"id": 123,
"name": "<string>"
},
"import": {
"id": 123
}
}
],
"evidence": [
{
"session_id": 123,
"date": "2023-12-25",
"session_status": "<string>",
"session_type": "<string>",
"revision": 123,
"is_correction": true,
"recorded_at": "2023-11-07T05:31:56Z",
"source": "<string>",
"site": "<string>",
"cohort": "<string>",
"destination_site": "<string>",
"destination_cohort": "<string>",
"reason_code": "<string>",
"note": "<string>",
"effective_on": "2023-12-25",
"new_entrant": true,
"operator": {
"id": 123,
"name": "<string>"
},
"import": {
"id": 123
},
"encounter_status": "seen",
"enrollment_confirmation": "confirmed_enrolled",
"evidence_source": "official_record"
}
]
}{
"message": "Unauthorized",
"status": "error"
}{
"message": "Something went wrong. Please try again.",
"status": "error",
"error": "invalid_request",
"code": "DONOR_NOT_FOUND"
}{
"message": "Not Found",
"status": "error"
}Authorizations
Passport bearer token authentication for legacy admin sessions.
Path Parameters
Program whose participation setup, placements and checks are being accessed.
x >= 1Recipient ID within this program.
x >= 1curl --request GET \
--url https://api.gratona.com/v1/admin/programs/{program_id}/participation/recipients/{entity_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.gratona.com/v1/admin/programs/{program_id}/participation/recipients/{entity_id}"
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/programs/{program_id}/participation/recipients/{entity_id}', 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/programs/{program_id}/participation/recipients/{entity_id}",
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/programs/{program_id}/participation/recipients/{entity_id}"
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/programs/{program_id}/participation/recipients/{entity_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/programs/{program_id}/participation/recipients/{entity_id}")
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{
"recipient": {
"id": 123,
"display_name": "<string>",
"is_visible": true,
"is_archived": true,
"profile_readiness": {
"ready": true,
"status": "ready",
"missing_keys": [
"<string>"
],
"missing_labels": [
"<string>"
]
}
},
"current": {
"site": "<string>",
"cohort": "<string>",
"enrollment_state": "<string>",
"last_verified_on": "2023-12-25",
"last_seen_on": "2023-12-25",
"evidence_source": "<string>",
"consecutive_unresolved_checks": 123,
"unresolved_since": "2023-12-25",
"follow_up": {
"id": 123,
"title": "<string>",
"status": "<string>",
"due_date": "2023-12-25"
}
},
"placements": [
{
"id": 123,
"site": "<string>",
"cohort": "<string>",
"state": "<string>",
"started_on": "2023-12-25",
"ended_on": "2023-12-25",
"current": true,
"source": "<string>",
"recorded_at": "2023-11-07T05:31:56Z",
"source_session_id": 123,
"revision": 123,
"reason_code": "<string>",
"note": "<string>",
"operator": {
"id": 123,
"name": "<string>"
},
"import": {
"id": 123
}
}
],
"evidence": [
{
"session_id": 123,
"date": "2023-12-25",
"session_status": "<string>",
"session_type": "<string>",
"revision": 123,
"is_correction": true,
"recorded_at": "2023-11-07T05:31:56Z",
"source": "<string>",
"site": "<string>",
"cohort": "<string>",
"destination_site": "<string>",
"destination_cohort": "<string>",
"reason_code": "<string>",
"note": "<string>",
"effective_on": "2023-12-25",
"new_entrant": true,
"operator": {
"id": 123,
"name": "<string>"
},
"import": {
"id": 123
},
"encounter_status": "seen",
"enrollment_confirmation": "confirmed_enrolled",
"evidence_source": "official_record"
}
]
}{
"message": "Unauthorized",
"status": "error"
}{
"message": "Something went wrong. Please try again.",
"status": "error",
"error": "invalid_request",
"code": "DONOR_NOT_FOUND"
}{
"message": "Not Found",
"status": "error"
}