Start or reuse a participation check
Requires the participation feature, programs_view and access to this organization-owned program. Requires participation_record, participation_submit or participation_configure and access to the check’s site/cohort. Requires enabled setup, an open period, an active site/group and a date within that period. Snapshots placements active on the inclusive check date. The idempotency key is organization-wide and must replay matching program, period, location/group, date, type and evidence source. Returns 201 for a new draft or 200 for replay/reuse. Fixed cadence reuses a draft/submitted check in that window; flexible cadence reuses only a draft on the exact date.
curl --request POST \
--url https://api.gratona.com/v1/admin/programs/{program_id}/participation/sessions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"participation_period_id": 42,
"program_site_id": 42,
"scheduled_for": "2026-10-20",
"primary_evidence_source": "staff_confirmation",
"idempotency_key": "participation-check-2026-10-20-campus-42",
"program_cohort_id": 42,
"session_type": "roster_verification",
"source_note": "<string>"
}
'import requests
url = "https://api.gratona.com/v1/admin/programs/{program_id}/participation/sessions"
payload = {
"participation_period_id": 42,
"program_site_id": 42,
"scheduled_for": "2026-10-20",
"primary_evidence_source": "staff_confirmation",
"idempotency_key": "participation-check-2026-10-20-campus-42",
"program_cohort_id": 42,
"session_type": "roster_verification",
"source_note": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
participation_period_id: 42,
program_site_id: 42,
scheduled_for: '2026-10-20',
primary_evidence_source: 'staff_confirmation',
idempotency_key: 'participation-check-2026-10-20-campus-42',
program_cohort_id: 42,
session_type: 'roster_verification',
source_note: '<string>'
})
};
fetch('https://api.gratona.com/v1/admin/programs/{program_id}/participation/sessions', 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/sessions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'participation_period_id' => 42,
'program_site_id' => 42,
'scheduled_for' => '2026-10-20',
'primary_evidence_source' => 'staff_confirmation',
'idempotency_key' => 'participation-check-2026-10-20-campus-42',
'program_cohort_id' => 42,
'session_type' => 'roster_verification',
'source_note' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.gratona.com/v1/admin/programs/{program_id}/participation/sessions"
payload := strings.NewReader("{\n \"participation_period_id\": 42,\n \"program_site_id\": 42,\n \"scheduled_for\": \"2026-10-20\",\n \"primary_evidence_source\": \"staff_confirmation\",\n \"idempotency_key\": \"participation-check-2026-10-20-campus-42\",\n \"program_cohort_id\": 42,\n \"session_type\": \"roster_verification\",\n \"source_note\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.gratona.com/v1/admin/programs/{program_id}/participation/sessions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"participation_period_id\": 42,\n \"program_site_id\": 42,\n \"scheduled_for\": \"2026-10-20\",\n \"primary_evidence_source\": \"staff_confirmation\",\n \"idempotency_key\": \"participation-check-2026-10-20-campus-42\",\n \"program_cohort_id\": 42,\n \"session_type\": \"roster_verification\",\n \"source_note\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/programs/{program_id}/participation/sessions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"participation_period_id\": 42,\n \"program_site_id\": 42,\n \"scheduled_for\": \"2026-10-20\",\n \"primary_evidence_source\": \"staff_confirmation\",\n \"idempotency_key\": \"participation-check-2026-10-20-campus-42\",\n \"program_cohort_id\": 42,\n \"session_type\": \"roster_verification\",\n \"source_note\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"program_id": 123,
"scheduled_for": "2023-12-25",
"revision": 123,
"supersedes_session_id": 123,
"lock_version": 123,
"partial_reason": "<string>",
"source_note": "<string>",
"submitted_at": "2023-11-07T05:31:56Z",
"voided_at": "2023-11-07T05:31:56Z",
"void_reason": "<string>",
"available_new_entrants_count": 123,
"period": {
"id": 123,
"name": "<string>"
},
"site": {
"id": 123,
"name": "<string>"
},
"cohort": {
"id": 123,
"name": "<string>"
},
"session_type": "roster_verification",
"status": "draft",
"series_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"primary_evidence_source": "official_record",
"counts": {
"expected": 123,
"seen": 123,
"confirmed_enrolled": 123,
"unresolved": 123,
"not_checked": 123,
"not_expected": 123,
"new_entrant": 123
},
"observations": [
{
"id": 123,
"entity_id": 123,
"gratona_id": 123,
"display_name": "<string>",
"is_archived": true,
"thumbnail_url": "<string>",
"site_name": "<string>",
"cohort_name": "<string>",
"expected_in_roster": true,
"is_new_entrant": true,
"reason_code": "<string>",
"note": "<string>",
"effective_on": "2023-12-25",
"destination_program_site_id": 123,
"destination_program_cohort_id": 123,
"destination_recipient_placement_id": 123,
"follow_up": {
"id": 123,
"due_date": "2023-12-25"
},
"encounter_status": "seen",
"enrollment_confirmation": "confirmed_enrolled",
"evidence_source": "official_record"
}
]
}{
"id": 123,
"program_id": 123,
"scheduled_for": "2023-12-25",
"revision": 123,
"supersedes_session_id": 123,
"lock_version": 123,
"partial_reason": "<string>",
"source_note": "<string>",
"submitted_at": "2023-11-07T05:31:56Z",
"voided_at": "2023-11-07T05:31:56Z",
"void_reason": "<string>",
"available_new_entrants_count": 123,
"period": {
"id": 123,
"name": "<string>"
},
"site": {
"id": 123,
"name": "<string>"
},
"cohort": {
"id": 123,
"name": "<string>"
},
"session_type": "roster_verification",
"status": "draft",
"series_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"primary_evidence_source": "official_record",
"counts": {
"expected": 123,
"seen": 123,
"confirmed_enrolled": 123,
"unresolved": 123,
"not_checked": 123,
"not_expected": 123,
"new_entrant": 123
},
"observations": [
{
"id": 123,
"entity_id": 123,
"gratona_id": 123,
"display_name": "<string>",
"is_archived": true,
"thumbnail_url": "<string>",
"site_name": "<string>",
"cohort_name": "<string>",
"expected_in_roster": true,
"is_new_entrant": true,
"reason_code": "<string>",
"note": "<string>",
"effective_on": "2023-12-25",
"destination_program_site_id": 123,
"destination_program_cohort_id": 123,
"destination_recipient_placement_id": 123,
"follow_up": {
"id": 123,
"due_date": "2023-12-25"
},
"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"
}{
"errors": {},
"status": "error",
"message": "The given data was invalid."
}Authorizations
Passport bearer token authentication for legacy admin sessions.
Path Parameters
Program whose participation setup, placements and checks are being accessed.
x >= 1Body
Request fields accepted by this operation. Omitted optional properties retain the behavior described above.
x >= 142
x >= 142
"2026-10-20"
official_record, headcount, staff_confirmation, participant_confirmation, legacy_import, other "staff_confirmation"
1 - 255"participation-check-2026-10-20-campus-42"
x >= 142
roster_verification 2000Response
Existing matching request or cadence check reused.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
"roster_verification"
draft, submitted, superseded, voided official_record, headcount, staff_confirmation, participant_confirmation, legacy_import, other Show child attributes
Show child attributes
Complete roster ordered by display-name snapshot; observation IDs are scoped to this check.
Show child attributes
Show child attributes
curl --request POST \
--url https://api.gratona.com/v1/admin/programs/{program_id}/participation/sessions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"participation_period_id": 42,
"program_site_id": 42,
"scheduled_for": "2026-10-20",
"primary_evidence_source": "staff_confirmation",
"idempotency_key": "participation-check-2026-10-20-campus-42",
"program_cohort_id": 42,
"session_type": "roster_verification",
"source_note": "<string>"
}
'import requests
url = "https://api.gratona.com/v1/admin/programs/{program_id}/participation/sessions"
payload = {
"participation_period_id": 42,
"program_site_id": 42,
"scheduled_for": "2026-10-20",
"primary_evidence_source": "staff_confirmation",
"idempotency_key": "participation-check-2026-10-20-campus-42",
"program_cohort_id": 42,
"session_type": "roster_verification",
"source_note": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
participation_period_id: 42,
program_site_id: 42,
scheduled_for: '2026-10-20',
primary_evidence_source: 'staff_confirmation',
idempotency_key: 'participation-check-2026-10-20-campus-42',
program_cohort_id: 42,
session_type: 'roster_verification',
source_note: '<string>'
})
};
fetch('https://api.gratona.com/v1/admin/programs/{program_id}/participation/sessions', 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/sessions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'participation_period_id' => 42,
'program_site_id' => 42,
'scheduled_for' => '2026-10-20',
'primary_evidence_source' => 'staff_confirmation',
'idempotency_key' => 'participation-check-2026-10-20-campus-42',
'program_cohort_id' => 42,
'session_type' => 'roster_verification',
'source_note' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.gratona.com/v1/admin/programs/{program_id}/participation/sessions"
payload := strings.NewReader("{\n \"participation_period_id\": 42,\n \"program_site_id\": 42,\n \"scheduled_for\": \"2026-10-20\",\n \"primary_evidence_source\": \"staff_confirmation\",\n \"idempotency_key\": \"participation-check-2026-10-20-campus-42\",\n \"program_cohort_id\": 42,\n \"session_type\": \"roster_verification\",\n \"source_note\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.gratona.com/v1/admin/programs/{program_id}/participation/sessions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"participation_period_id\": 42,\n \"program_site_id\": 42,\n \"scheduled_for\": \"2026-10-20\",\n \"primary_evidence_source\": \"staff_confirmation\",\n \"idempotency_key\": \"participation-check-2026-10-20-campus-42\",\n \"program_cohort_id\": 42,\n \"session_type\": \"roster_verification\",\n \"source_note\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/programs/{program_id}/participation/sessions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"participation_period_id\": 42,\n \"program_site_id\": 42,\n \"scheduled_for\": \"2026-10-20\",\n \"primary_evidence_source\": \"staff_confirmation\",\n \"idempotency_key\": \"participation-check-2026-10-20-campus-42\",\n \"program_cohort_id\": 42,\n \"session_type\": \"roster_verification\",\n \"source_note\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"program_id": 123,
"scheduled_for": "2023-12-25",
"revision": 123,
"supersedes_session_id": 123,
"lock_version": 123,
"partial_reason": "<string>",
"source_note": "<string>",
"submitted_at": "2023-11-07T05:31:56Z",
"voided_at": "2023-11-07T05:31:56Z",
"void_reason": "<string>",
"available_new_entrants_count": 123,
"period": {
"id": 123,
"name": "<string>"
},
"site": {
"id": 123,
"name": "<string>"
},
"cohort": {
"id": 123,
"name": "<string>"
},
"session_type": "roster_verification",
"status": "draft",
"series_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"primary_evidence_source": "official_record",
"counts": {
"expected": 123,
"seen": 123,
"confirmed_enrolled": 123,
"unresolved": 123,
"not_checked": 123,
"not_expected": 123,
"new_entrant": 123
},
"observations": [
{
"id": 123,
"entity_id": 123,
"gratona_id": 123,
"display_name": "<string>",
"is_archived": true,
"thumbnail_url": "<string>",
"site_name": "<string>",
"cohort_name": "<string>",
"expected_in_roster": true,
"is_new_entrant": true,
"reason_code": "<string>",
"note": "<string>",
"effective_on": "2023-12-25",
"destination_program_site_id": 123,
"destination_program_cohort_id": 123,
"destination_recipient_placement_id": 123,
"follow_up": {
"id": 123,
"due_date": "2023-12-25"
},
"encounter_status": "seen",
"enrollment_confirmation": "confirmed_enrolled",
"evidence_source": "official_record"
}
]
}{
"id": 123,
"program_id": 123,
"scheduled_for": "2023-12-25",
"revision": 123,
"supersedes_session_id": 123,
"lock_version": 123,
"partial_reason": "<string>",
"source_note": "<string>",
"submitted_at": "2023-11-07T05:31:56Z",
"voided_at": "2023-11-07T05:31:56Z",
"void_reason": "<string>",
"available_new_entrants_count": 123,
"period": {
"id": 123,
"name": "<string>"
},
"site": {
"id": 123,
"name": "<string>"
},
"cohort": {
"id": 123,
"name": "<string>"
},
"session_type": "roster_verification",
"status": "draft",
"series_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"primary_evidence_source": "official_record",
"counts": {
"expected": 123,
"seen": 123,
"confirmed_enrolled": 123,
"unresolved": 123,
"not_checked": 123,
"not_expected": 123,
"new_entrant": 123
},
"observations": [
{
"id": 123,
"entity_id": 123,
"gratona_id": 123,
"display_name": "<string>",
"is_archived": true,
"thumbnail_url": "<string>",
"site_name": "<string>",
"cohort_name": "<string>",
"expected_in_roster": true,
"is_new_entrant": true,
"reason_code": "<string>",
"note": "<string>",
"effective_on": "2023-12-25",
"destination_program_site_id": 123,
"destination_program_cohort_id": 123,
"destination_recipient_placement_id": 123,
"follow_up": {
"id": 123,
"due_date": "2023-12-25"
},
"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"
}{
"errors": {},
"status": "error",
"message": "The given data was invalid."
}