> ## Documentation Index > Fetch the complete documentation index at: https://api-docs.helpyousponsor.com/llms.txt > Use this file to discover all available pages before exploring further. # 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. ## OpenAPI ````yaml get /admin/events/{eventId}/invitees openapi: 3.0.0 info: title: Gratona API description: >- REST API for the Gratona fundraising platform, including donor, donation, sponsorship, program, event, and integration workflows. Endpoints are organized by tag. Most endpoints require either a Passport bearer token or an issued API key — see the Security Schemes section. contact: name: Gratona Engineering url: https://gratona.com email: devs@gratona.com version: 1.0.0 servers: - url: https://api.gratona.com/v1 description: Server Version 1.0.0 security: [] tags: - name: Auth description: >- Login, signup, logout, password reset, and email verification for admin users and donors. - name: Donors description: >- Donor records: CRUD, profile fields, household linkage, search, filters, merge, and duplicate detection. - name: Donations description: >- Individual donation records, recurring commitments, soft credits, refunds, designations, and exports. - name: Sponsorships description: >- Donor-to-entity commitment relationships, lifecycle transitions, and commitment-specific filters. - name: Entities description: >- Recipient records (children, families, projects, animals, etc.), their status, and entity-level fields. - name: Programs description: >- Program / campaign configuration: hierarchy, settings, and program-level metadata. - name: Forms description: >- Custom form builder (HysForm), form fields, standardized donor fields, and field migrations. - name: Trips description: >- Mission-trip management: trips, participants, budgets, tasks, e-signatures, fundraising milestones, and background checks. - name: Communications description: >- Email templates, SMS, newsletters, donor email manager, and per-donor notes. - name: Payments description: >- Payment-gateway management (Stripe, PayPal, Flutterwave, QuickBooks). Excludes inbound webhooks — see the Webhooks tag. - name: Reports description: Dashboards, analytics, scheduled reports, and exports. - name: Admin description: >- Client-account administration: users, groups/permissions, settings, integrations, and account lifecycle. - name: Donor Portal description: >- Endpoints consumed by the donor-facing portal (donor login, dashboard, donation history, messages). - name: Recipient Portal description: Endpoints consumed by the recipient-facing portal. - name: Public description: >- Unauthenticated public endpoints: donor signup, public trip pages, peer-to-peer campaigns, public checkout. - name: Webhooks description: >- Inbound webhooks from third parties (Stripe, PayPal, Flutterwave, Checkr, DropboxSign). Annotated minimally for reference; payload shapes are owned by the upstream provider. - name: Events description: >- Event setup, invitations, registration, ticketing, attendance and event reporting. - name: Journeys description: >- Journey graphs, activation, enrollment, message templates and event follow-up automations. - name: Tasks description: Workspace tasks, assignments, saved task views and record collaboration. - name: Fundraising description: >- Fundraising portfolios, stewardship plans, giving anniversaries and personal donor follow-up. - name: Impact Stories description: Story intake, review, assets, consent and publication workflows. - name: Integrations description: Workspace integration connections, mappings, synchronization and recovery. - name: Email Calendar description: Connected email/calendar accounts and donor interactions. - name: Spaces description: Workspace Spaces and collaborative Pages. - name: Library description: Workspace documents, source connections, files and analysis. - name: Intelligence description: Donor intelligence and Tali workspace workflows. - name: Automation description: >- V3 automation primitive discovery, input validation, invocation and Zapier contracts. - name: Schema description: V3 model, enum, capability and scope discovery. - name: Zapier description: Zapier automation connections, polling feeds and actions. - name: Files description: Files - name: Client description: Client - name: Payment Gateways description: Payment Gateways - name: Email Settings description: Email Settings - name: Admin Dashboard description: Admin Dashboard - name: Recipients description: Recipients - name: Historical Archived Updates description: Historical Archived Updates - name: Team & access description: Team & access - name: Settings description: Settings - name: Notifications description: Notifications - name: Participation description: Participation - name: Users description: Users - name: Wrapped description: Wrapped - name: Donor SignUp description: Donor SignUp - name: Frontend description: Frontend - name: User description: User - name: Workspace description: Workspace paths: /admin/events/{eventId}/invitees: get: tags: - Events summary: List event invitees description: >- 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. operationId: EventInvitationController_index parameters: - name: eventId in: path description: Record ID in the authenticated organization. required: true schema: type: integer example: 42 example: 42 - name: page in: query description: One-based page. required: false schema: type: integer minimum: 1 example: 1 example: 1 - name: per_page in: query description: Rows per page; default 50. required: false schema: type: integer maximum: 100 minimum: 1 example: 50 example: 50 - name: search in: query description: Search donor names, organization, email and username. required: false schema: type: string maxLength: 255 example: Jane example: Jane - name: stage in: query description: >- Computed outreach stage; confirmed attendance takes precedence over invitation disposition. required: false schema: type: string enum: - to_invite - in_progress - awaiting_rsvp - plans_to_attend - maybe - needs_follow_up - confirmed - declined - closed example: to_invite example: to_invite - name: owner_user_id in: query description: Filter to this staff owner. required: false schema: type: integer minimum: 1 example: 42 example: 42 - name: plan_state in: query description: Computed visible plan state. required: false schema: type: string enum: - none - not_started - in_progress - complete - missing_task example: none example: none - name: method in: query description: Invitation contact method. required: false schema: type: string enum: - phone_call - text_message - email - handwritten_note - printed_mail - in_person - voicemail - other example: phone_call example: phone_call - name: work_scope in: query description: Owner or next-task scope in event timezone. required: false schema: type: string enum: - my_invitees - overdue - due_this_week example: my_invitees example: my_invitees - name: sort in: query description: Sort key; defaults name, missing task/owner values last. required: false schema: type: string enum: - name - next_task - last_interaction - stage - owner example: name example: name - name: direction in: query description: Sort direction; default asc. required: false schema: type: string enum: - asc - desc example: asc example: asc responses: '200': description: List event invitees completed. content: application/json: schema: $ref: '#/components/schemas/EventApiInviteeIndex' '401': description: Authentication is required. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Insufficient permission or feature access. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Resource not found in the organization or feature unavailable. content: application/json: schema: $ref: '#/components/schemas/NotFoundResponse' '422': description: Invalid request, owner, plan step/date or selection. content: application/json: schema: $ref: '#/components/schemas/RequestRejection' security: - bearerAuth: [] - apiKeyAuth: [] components: schemas: EventApiInviteeIndex: properties: data: type: array items: $ref: '#/components/schemas/EventApiInvitee' summary: properties: visible_total: description: Accessible invitee count for visible total. type: integer example: 42 to_invite: description: Accessible invitee count for to invite. type: integer example: 42 in_progress: description: Accessible invitee count for in progress. type: integer example: 42 awaiting_rsvp: description: Accessible invitee count for awaiting rsvp. type: integer example: 42 plans_to_attend: description: Accessible invitee count for plans to attend. type: integer example: 42 maybe: description: Accessible invitee count for maybe. type: integer example: 42 needs_follow_up: description: Accessible invitee count for needs follow up. type: integer example: 42 confirmed: description: Accessible invitee count for confirmed. type: integer example: 42 declined: description: Accessible invitee count for declined. type: integer example: 42 closed: description: Accessible invitee count for closed. type: integer example: 42 type: object pagination: properties: current_page: description: Current one-based page. type: integer example: 42 last_page: description: Last page. type: integer example: 42 per_page: description: Maximum rows per page. type: integer example: 42 total: description: Total matching rows. type: integer example: 42 type: object type: object ErrorResponse: title: ErrorResponse description: >- Generic error envelope used by most controllers. Most error responses pair a human-readable `message` with `status: error`. Some endpoints additionally include `errors` (validator errors), `error` (legacy single-error string), `code`, or domain-specific context fields. required: - message properties: message: description: Human-readable error message. type: string example: Something went wrong. Please try again. status: description: >- Always the literal string `error` for failures. Some endpoints omit this field. type: string example: error error: description: Legacy single error code/string used by older endpoints. type: string example: invalid_request nullable: true code: description: >- Optional application-level error code (not all endpoints populate this). type: string example: DONOR_NOT_FOUND nullable: true type: object NotFoundResponse: title: NotFoundResponse description: >- Returned with HTTP 404 when a resource lookup misses (typically because the id doesn't exist OR is scoped to a different `client_id`). Note: many endpoints intentionally collapse 'not found' and 'forbidden' into a single 404 to avoid leaking which records exist in another tenant. required: - message properties: message: description: >- Human-readable message. Often a more specific string like `Donor not found` or `Trip not found`. type: string example: Not Found status: type: string example: error type: object RequestRejection: description: >- Request or workflow rejection. Framework field-validation failures contain errors; semantic rejections may contain message without errors; legacy/provider failures may use error and error_code. The operation description identifies the rejected condition. Domain responses may add current revision, limits or other conflict context. anyOf: - $ref: '#/components/schemas/ValidationErrorResponse' - $ref: '#/components/schemas/ErrorResponse' - required: - error properties: error: description: Legacy or provider-facing error message. type: string example: The request could not be completed. error_code: description: Stable domain error code, when provided. type: string example: WORKFLOW_UNAVAILABLE type: object EventApiInvitee: properties: id: description: Invitee ID. type: integer example: 42 version: description: Current invitee version from the list. type: integer minimum: 1 example: 1 donor: properties: id: description: Accessible donor ID. type: integer example: 42 display_name: description: Resolved donor name. type: string example: Jane Doe email: description: Masked email; null if no valid address. type: string example: j***@example.org nullable: true type: object owner: properties: id: description: Staff user ID. type: integer example: 42 name: description: Staff display name. type: string example: Alex Smith type: object nullable: true stage: description: >- Computed outreach stage; confirmed attendance takes precedence over invitation disposition. type: string enum: - to_invite - in_progress - awaiting_rsvp - plans_to_attend - maybe - needs_follow_up - confirmed - declined - closed example: to_invite disposition: description: Stored invitation disposition. type: string enum: - open - declined - closed example: open response_outcome: description: Recorded invitation response. type: string enum: - accepted - maybe - declined - needs_follow_up - null example: accepted nullable: true plan: properties: id: description: Plan ID. type: integer example: 42 name: description: Applied plan name. type: string example: Personal invitation revision: description: Applied revision. type: integer example: 42 completed: description: Visible completed plan tasks. type: integer example: 42 total: description: Visible plan task mappings. type: integer example: 42 missing_tasks: description: Missing/deleted canonical tasks. type: integer example: 42 tasks: type: array items: properties: step_key: description: Applied step key. type: string example: personal_call label: description: Applied step label. type: string example: Personal call method: description: Invitation contact method. type: string enum: - phone_call - text_message - email - handwritten_note - printed_mail - in_person - voicemail - other - null example: phone_call nullable: true id: description: Canonical task ID. type: integer example: 42 nullable: true version: description: Task lock version. type: integer example: 42 nullable: true title: description: Task title. type: string example: Example nullable: true status: description: Task state or missing. type: string example: open due_date: description: Current task due date. type: string format: date example: '2026-11-01' nullable: true assignee: properties: id: description: Staff user ID. type: integer example: 42 name: description: Staff display name. type: string example: Alex Smith type: object nullable: true canonical_task: oneOf: - $ref: '#/components/schemas/TaskWorkspaceRecordDoc' - type: string enum: - null nullable: true type: object type: object nullable: true next_task: properties: id: description: Next open task ID. type: integer example: 42 title: description: Task title. type: string example: Call Jane due_date: description: Due date. type: string format: date example: '2026-11-01' nullable: true version: description: Task version. type: integer minimum: 1 example: 1 type: object nullable: true last_interaction: properties: id: description: Visible activity ID. type: integer example: 42 type: description: Activity type. type: string example: phone_call method: description: Invitation contact method. type: string enum: - phone_call - text_message - email - handwritten_note - printed_mail - in_person - voicemail - other - null example: phone_call nullable: true action: description: Invitation action such as attempt, sent or response. type: string example: Example nullable: true occurred_at: description: Activity time. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true type: object nullable: true methods: type: array items: description: Invitation contact method. type: string enum: - phone_call - text_message - email - handwritten_note - printed_mail - in_person - voicemail - other example: phone_call recent_interactions: description: At most five visible interactions. type: array items: properties: id: description: Visible activity ID. type: integer example: 42 type: description: Activity type. type: string example: phone_call method: description: Invitation contact method. type: string enum: - phone_call - text_message - email - handwritten_note - printed_mail - in_person - voicemail - other - null example: phone_call nullable: true action: description: Invitation action such as attempt, sent or response. type: string example: Example nullable: true response_outcome: description: Recent response outcome; recent_interactions only. type: string example: Example nullable: true occurred_at: description: Activity time. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true type: object maxItems: 5 other_tasks: description: Other accessible canonical tasks linked to this donor and event. type: array items: $ref: '#/components/schemas/TaskWorkspaceRecordDoc' attendance: properties: status: description: >- registered/checked_in when qualifying attendee exists; otherwise null. type: string example: Example nullable: true type: object access_link: properties: id: description: Available invitation link ID; secret is never returned here. type: integer example: 42 nullable: true active: description: Available non-revoked, unexpired link exists. type: boolean example: false expires_at: description: Link expiration. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true type: object actions: properties: manage: description: Manage. type: boolean example: false manage_tasks: description: Manage tasks. type: boolean example: false apply_plan: description: Apply plan. type: boolean example: false log_interaction: description: Log interaction. type: boolean example: false create_registration: description: Create registration. type: boolean example: false type: object type: object ValidationErrorResponse: title: ValidationErrorResponse description: >- Returned with HTTP 422 when `Validator::make($data, $rules)` fails. The `errors` map is keyed by the failing field name; each value is an array of human-readable error messages for that field. Most controllers also include a top-level `status: error`. required: - errors properties: errors: description: >- Map of field name to array of validator error messages. Example: `{email: [The email field is required.], amount: [The amount must be a number.]}`. type: object additionalProperties: type: array items: type: string status: description: Always the literal string `error`. type: string example: error message: description: >- Optional summary message — present on some endpoints, absent on others. type: string example: The given data was invalid. nullable: true type: object TaskWorkspaceRecordDoc: properties: id: type: integer title: type: string status: type: string due_date: type: string format: date nullable: true due_label: type: string due_state: type: string assigned_to_user_id: type: integer nullable: true created_by_user_id: type: integer completed_at: type: string format: date-time nullable: true source: type: string nullable: true version: type: integer created_at: type: string format: date-time nullable: true updated_at: type: string format: date-time nullable: true body_json: description: >- Structured editor document; an empty document may be serialized as an array. type: object additionalProperties: true assigned_to: properties: id: type: integer name: type: string email: type: string nullable: true type: object nullable: true created_by: properties: id: type: integer name: type: string email: type: string nullable: true type: object nullable: true completed_by: properties: id: type: integer name: type: string email: type: string nullable: true type: object nullable: true links: type: array items: properties: id: type: integer record_type: type: string record_id: type: integer nullable: true related_type: type: string related_id: type: integer nullable: true type_label: type: string program_type: type: string nullable: true label: type: string secondary: type: string nullable: true url: type: string nullable: true is_primary: type: boolean visibility_required: type: boolean is_accessible: type: boolean type: object mentions: type: array items: properties: id: type: integer mention_type: type: string user_id: type: integer nullable: true record_type: type: string nullable: true record_id: type: integer nullable: true related_type: type: string nullable: true related_id: type: integer nullable: true type_label: type: string nullable: true program_type: type: string nullable: true label: type: string is_accessible: type: boolean type: object type: object securitySchemes: bearerAuth: type: http description: Passport bearer token authentication for legacy admin sessions. scheme: bearer bearerFormat: JWT apiKeyAuth: type: apiKey description: Gratona API key sent with the compatibility header X-HYS-API-Key. name: X-HYS-API-Key in: header ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.