> ## 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 events > Lists events by lifecycle view, text search and sortable fields. include_summary adds organization-wide counts and the next event, rather than counts restricted by list filters. Requires the event view capability; all records are scoped to the authenticated organization. ## OpenAPI ````yaml get /admin/events 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: get: tags: - Events summary: List events description: >- Lists events by lifecycle view, text search and sortable fields. include_summary adds organization-wide counts and the next event, rather than counts restricted by list filters. Requires the event view capability; all records are scoped to the authenticated organization. operationId: EventController_index parameters: - 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; clamped to 1–100. required: false schema: type: integer maximum: 100 minimum: 1 example: 20 example: 20 - name: view in: query description: Lifecycle view; default all. required: false schema: type: string enum: - all - upcoming - active - draft - past - archived example: all example: all - name: status in: query description: Exact status filter. required: false schema: type: string example: registration_open example: registration_open - name: search in: query description: Search name, slug, location, type and status. required: false schema: type: string example: gala example: gala - name: sort in: query description: >- name, starts_at, status or created_at; prefix minus for descending. Unknown values fall back to -created_at. required: false schema: type: string example: '-created_at' example: '-created_at' - name: include_summary in: query description: Add organization-wide summary counts. required: false schema: type: boolean example: false example: false responses: '200': description: List events completed. content: application/json: schema: properties: data: type: array items: properties: id: description: Id. type: integer example: 42 registered_attendee_count: description: Registered attendee count. type: integer example: 42 checked_in_count: description: Checked in count. type: integer example: 42 completed_order_count: description: Completed order count. type: integer example: 42 name: description: Name. type: string example: Example nullable: true slug: description: Slug. type: string example: Example nullable: true type: description: Type. type: string example: Example nullable: true status: description: Status. type: string example: Example nullable: true timezone: description: Timezone. type: string example: Example nullable: true location_name: description: Location name. type: string example: Example nullable: true starts_at: description: Starts at. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true ends_at: description: Ends at. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true created_at: description: Created at. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true type: object meta: 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 summary: properties: total: description: Total. type: integer example: 42 upcoming: description: Upcoming. type: integer example: 42 active: description: Active. type: integer example: 42 draft: description: Draft. type: integer example: 42 registered: description: Registered. type: integer example: 42 checked_in: description: Checked in. type: integer example: 42 completed_orders: description: Completed orders. type: integer example: 42 next_event: properties: id: description: Record ID in the authenticated organization. type: integer example: 42 name: description: Event name. type: string example: Annual Gala starts_at: description: Event start. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true timezone: description: Event timezone. type: string example: Africa/Kampala type: object nullable: true type: object type: object '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' security: - bearerAuth: [] - apiKeyAuth: [] components: schemas: 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 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.