List event invitees
Returns active invitees with masked donor contacts, computed stages, visible plan tasks/interactions and actions. Summary respects search/owner visibility before stage, method, plan-state and work-scope filters. Task and interaction projections follow their separate record visibility rules. Requires event view capability and organization/donor visibility.
curl --request GET \
--url https://api.gratona.com/v1/admin/events/{eventId}/invitees \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.gratona.com/v1/admin/events/{eventId}/invitees"
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/events/{eventId}/invitees', 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/events/{eventId}/invitees",
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/events/{eventId}/invitees"
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/events/{eventId}/invitees")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/events/{eventId}/invitees")
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{
"data": [
{
"id": 42,
"version": 1,
"donor": {
"id": 42,
"display_name": "Jane Doe",
"email": "j***@example.org"
},
"owner": {
"id": 42,
"name": "Alex Smith"
},
"stage": "to_invite",
"disposition": "open",
"response_outcome": "accepted",
"plan": {
"id": 42,
"name": "Personal invitation",
"revision": 42,
"completed": 42,
"total": 42,
"missing_tasks": 42,
"tasks": [
{
"step_key": "personal_call",
"label": "Personal call",
"method": "phone_call",
"id": 42,
"version": 42,
"title": "Example",
"status": "open",
"due_date": "2026-11-01",
"assignee": {
"id": 42,
"name": "Alex Smith"
},
"canonical_task": {
"id": 123,
"title": "<string>",
"status": "<string>",
"due_date": "2023-12-25",
"due_label": "<string>",
"due_state": "<string>",
"assigned_to_user_id": 123,
"created_by_user_id": 123,
"completed_at": "2023-11-07T05:31:56Z",
"source": "<string>",
"version": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"body_json": {},
"assigned_to": {
"id": 123,
"name": "<string>",
"email": "<string>"
},
"created_by": {
"id": 123,
"name": "<string>",
"email": "<string>"
},
"completed_by": {
"id": 123,
"name": "<string>",
"email": "<string>"
},
"links": [
{
"id": 123,
"record_type": "<string>",
"record_id": 123,
"related_type": "<string>",
"related_id": 123,
"type_label": "<string>",
"program_type": "<string>",
"label": "<string>",
"secondary": "<string>",
"url": "<string>",
"is_primary": true,
"visibility_required": true,
"is_accessible": true
}
],
"mentions": [
{
"id": 123,
"mention_type": "<string>",
"user_id": 123,
"record_type": "<string>",
"record_id": 123,
"related_type": "<string>",
"related_id": 123,
"type_label": "<string>",
"program_type": "<string>",
"label": "<string>",
"is_accessible": true
}
]
}
}
]
},
"next_task": {
"id": 42,
"title": "Call Jane",
"due_date": "2026-11-01",
"version": 1
},
"last_interaction": {
"id": 42,
"type": "phone_call",
"method": "phone_call",
"action": "Example",
"occurred_at": "2026-10-20T12:00:00Z"
},
"methods": [
"phone_call"
],
"recent_interactions": [
{
"id": 42,
"type": "phone_call",
"method": "phone_call",
"action": "Example",
"response_outcome": "Example",
"occurred_at": "2026-10-20T12:00:00Z"
}
],
"other_tasks": [
{
"id": 123,
"title": "<string>",
"status": "<string>",
"due_date": "2023-12-25",
"due_label": "<string>",
"due_state": "<string>",
"assigned_to_user_id": 123,
"created_by_user_id": 123,
"completed_at": "2023-11-07T05:31:56Z",
"source": "<string>",
"version": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"body_json": {},
"assigned_to": {
"id": 123,
"name": "<string>",
"email": "<string>"
},
"created_by": {
"id": 123,
"name": "<string>",
"email": "<string>"
},
"completed_by": {
"id": 123,
"name": "<string>",
"email": "<string>"
},
"links": [
{
"id": 123,
"record_type": "<string>",
"record_id": 123,
"related_type": "<string>",
"related_id": 123,
"type_label": "<string>",
"program_type": "<string>",
"label": "<string>",
"secondary": "<string>",
"url": "<string>",
"is_primary": true,
"visibility_required": true,
"is_accessible": true
}
],
"mentions": [
{
"id": 123,
"mention_type": "<string>",
"user_id": 123,
"record_type": "<string>",
"record_id": 123,
"related_type": "<string>",
"related_id": 123,
"type_label": "<string>",
"program_type": "<string>",
"label": "<string>",
"is_accessible": true
}
]
}
],
"attendance": {
"status": "Example"
},
"access_link": {
"id": 42,
"active": false,
"expires_at": "2026-10-20T12:00:00Z"
},
"actions": {
"manage": false,
"manage_tasks": false,
"apply_plan": false,
"log_interaction": false,
"create_registration": false
}
}
],
"summary": {
"visible_total": 42,
"to_invite": 42,
"in_progress": 42,
"awaiting_rsvp": 42,
"plans_to_attend": 42,
"maybe": 42,
"needs_follow_up": 42,
"confirmed": 42,
"declined": 42,
"closed": 42
},
"pagination": {
"current_page": 42,
"last_page": 42,
"per_page": 42,
"total": 42
}
}{
"message": "Something went wrong. Please try again.",
"status": "error",
"error": "invalid_request",
"code": "DONOR_NOT_FOUND"
}{
"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
Record ID in the authenticated organization.
42
Query Parameters
One-based page.
x >= 11
Rows per page; default 50.
1 <= x <= 10050
Search donor names, organization, email and username.
255"Jane"
Computed outreach stage; confirmed attendance takes precedence over invitation disposition.
to_invite, in_progress, awaiting_rsvp, plans_to_attend, maybe, needs_follow_up, confirmed, declined, closed "to_invite"
Filter to this staff owner.
x >= 142
Computed visible plan state.
none, not_started, in_progress, complete, missing_task "none"
Invitation contact method.
phone_call, text_message, email, handwritten_note, printed_mail, in_person, voicemail, other "phone_call"
Owner or next-task scope in event timezone.
my_invitees, overdue, due_this_week "my_invitees"
Sort key; defaults name, missing task/owner values last.
name, next_task, last_interaction, stage, owner "name"
Sort direction; default asc.
asc, desc "asc"
curl --request GET \
--url https://api.gratona.com/v1/admin/events/{eventId}/invitees \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.gratona.com/v1/admin/events/{eventId}/invitees"
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/events/{eventId}/invitees', 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/events/{eventId}/invitees",
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/events/{eventId}/invitees"
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/events/{eventId}/invitees")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/events/{eventId}/invitees")
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{
"data": [
{
"id": 42,
"version": 1,
"donor": {
"id": 42,
"display_name": "Jane Doe",
"email": "j***@example.org"
},
"owner": {
"id": 42,
"name": "Alex Smith"
},
"stage": "to_invite",
"disposition": "open",
"response_outcome": "accepted",
"plan": {
"id": 42,
"name": "Personal invitation",
"revision": 42,
"completed": 42,
"total": 42,
"missing_tasks": 42,
"tasks": [
{
"step_key": "personal_call",
"label": "Personal call",
"method": "phone_call",
"id": 42,
"version": 42,
"title": "Example",
"status": "open",
"due_date": "2026-11-01",
"assignee": {
"id": 42,
"name": "Alex Smith"
},
"canonical_task": {
"id": 123,
"title": "<string>",
"status": "<string>",
"due_date": "2023-12-25",
"due_label": "<string>",
"due_state": "<string>",
"assigned_to_user_id": 123,
"created_by_user_id": 123,
"completed_at": "2023-11-07T05:31:56Z",
"source": "<string>",
"version": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"body_json": {},
"assigned_to": {
"id": 123,
"name": "<string>",
"email": "<string>"
},
"created_by": {
"id": 123,
"name": "<string>",
"email": "<string>"
},
"completed_by": {
"id": 123,
"name": "<string>",
"email": "<string>"
},
"links": [
{
"id": 123,
"record_type": "<string>",
"record_id": 123,
"related_type": "<string>",
"related_id": 123,
"type_label": "<string>",
"program_type": "<string>",
"label": "<string>",
"secondary": "<string>",
"url": "<string>",
"is_primary": true,
"visibility_required": true,
"is_accessible": true
}
],
"mentions": [
{
"id": 123,
"mention_type": "<string>",
"user_id": 123,
"record_type": "<string>",
"record_id": 123,
"related_type": "<string>",
"related_id": 123,
"type_label": "<string>",
"program_type": "<string>",
"label": "<string>",
"is_accessible": true
}
]
}
}
]
},
"next_task": {
"id": 42,
"title": "Call Jane",
"due_date": "2026-11-01",
"version": 1
},
"last_interaction": {
"id": 42,
"type": "phone_call",
"method": "phone_call",
"action": "Example",
"occurred_at": "2026-10-20T12:00:00Z"
},
"methods": [
"phone_call"
],
"recent_interactions": [
{
"id": 42,
"type": "phone_call",
"method": "phone_call",
"action": "Example",
"response_outcome": "Example",
"occurred_at": "2026-10-20T12:00:00Z"
}
],
"other_tasks": [
{
"id": 123,
"title": "<string>",
"status": "<string>",
"due_date": "2023-12-25",
"due_label": "<string>",
"due_state": "<string>",
"assigned_to_user_id": 123,
"created_by_user_id": 123,
"completed_at": "2023-11-07T05:31:56Z",
"source": "<string>",
"version": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"body_json": {},
"assigned_to": {
"id": 123,
"name": "<string>",
"email": "<string>"
},
"created_by": {
"id": 123,
"name": "<string>",
"email": "<string>"
},
"completed_by": {
"id": 123,
"name": "<string>",
"email": "<string>"
},
"links": [
{
"id": 123,
"record_type": "<string>",
"record_id": 123,
"related_type": "<string>",
"related_id": 123,
"type_label": "<string>",
"program_type": "<string>",
"label": "<string>",
"secondary": "<string>",
"url": "<string>",
"is_primary": true,
"visibility_required": true,
"is_accessible": true
}
],
"mentions": [
{
"id": 123,
"mention_type": "<string>",
"user_id": 123,
"record_type": "<string>",
"record_id": 123,
"related_type": "<string>",
"related_id": 123,
"type_label": "<string>",
"program_type": "<string>",
"label": "<string>",
"is_accessible": true
}
]
}
],
"attendance": {
"status": "Example"
},
"access_link": {
"id": 42,
"active": false,
"expires_at": "2026-10-20T12:00:00Z"
},
"actions": {
"manage": false,
"manage_tasks": false,
"apply_plan": false,
"log_interaction": false,
"create_registration": false
}
}
],
"summary": {
"visible_total": 42,
"to_invite": 42,
"in_progress": 42,
"awaiting_rsvp": 42,
"plans_to_attend": 42,
"maybe": 42,
"needs_follow_up": 42,
"confirmed": 42,
"declined": 42,
"closed": 42
},
"pagination": {
"current_page": 42,
"last_page": 42,
"per_page": 42,
"total": 42
}
}{
"message": "Something went wrong. Please try again.",
"status": "error",
"error": "invalid_request",
"code": "DONOR_NOT_FOUND"
}{
"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."
}