> ## 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 journeys > Returns filtered journeys, health indicators, filtered summary counts and starter templates. Default ordering puts journeys needing attention first, followed by lifecycle priority and favorites. Read access requires journeys_view, journeys_manage or beta_features; records remain organization scoped. ## OpenAPI ````yaml get /admin/journeys 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/journeys: get: tags: - Journeys summary: List journeys description: >- Returns filtered journeys, health indicators, filtered summary counts and starter templates. Default ordering puts journeys needing attention first, followed by lifecycle priority and favorites. Read access requires journeys_view, journeys_manage or beta_features; records remain organization scoped. operationId: JourneyController_index parameters: - name: entity_type in: query description: >- Journey subject type; sponsorship availability follows the workspace lifecycle feature flag. required: false schema: type: string enum: - donor - trip_participant - entity - sponsorship example: donor example: donor - name: status in: query description: Lifecycle status or needs_attention. required: false schema: type: string example: active example: active - name: needs_attention in: query description: Restrict to journeys with health indicators. required: false schema: type: boolean example: false example: false - name: search in: query description: Search name and description. required: false schema: type: string example: welcome example: welcome - name: sort in: query description: >- Sort name, status, entity_type, created_at, updated_at, enrolled_count or completed_count; prefix with a minus for descending. required: false schema: type: string example: '-updated_at' example: '-updated_at' - 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–50, default 18. required: false schema: type: integer maximum: 50 minimum: 1 example: 18 example: 18 responses: '200': description: List journeys completed. content: application/json: schema: $ref: '#/components/schemas/JourneyApiIndex' '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: JourneyApiIndex: properties: data: type: array items: properties: id: description: Journey ID. type: integer example: 42 name: description: Journey name. type: string example: Welcome new donors description: description: Optional journey description. type: string example: Example nullable: true entity_type: description: >- Journey subject type; sponsorship availability follows the workspace lifecycle feature flag. type: string enum: - donor - trip_participant - entity - sponsorship example: donor status: description: Journey lifecycle status. type: string enum: - draft - active - paused - archived example: draft settings: description: >- Journey settings including favorite, allow_reentry and optional event_repeat_policy. type: object nullable: true additionalProperties: true enrolled_count: description: Lifetime enrolled count. type: integer example: 12 completed_count: description: Completed goal count. type: integer example: 3 can_edit_graph: description: True only for draft journeys. type: boolean example: false created_at: description: Creation timestamp. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true updated_at: description: Last update timestamp. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true is_favorite: description: Whether this journey is a favorite. type: boolean example: false needs_attention: description: Whether one or more health indicators are present. type: boolean example: false health_indicators: type: array items: properties: key: description: Health indicator key. type: string example: no_recent_entries label: description: Health indicator label. type: string example: No recent entries tone: description: Display severity. type: string enum: - warning - danger example: warning type: object active_count: description: Current active enrollment count. type: integer example: 42 last_entered_at: description: Most recent entry timestamp. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true step_count: description: Number of graph steps. type: integer example: 42 trigger_summary: description: Trigger summary. type: string example: When a donor joins type: object summary: properties: active: description: 'Count for the filtered journeys: active.' type: integer example: 42 draft: description: 'Count for the filtered journeys: draft.' type: integer example: 42 paused: description: 'Count for the filtered journeys: paused.' type: integer example: 42 archived: description: 'Count for the filtered journeys: archived.' type: integer example: 42 active_people: description: 'Count for the filtered journeys: active people.' type: integer example: 42 needs_attention: description: 'Count for the filtered journeys: needs attention.' type: integer example: 42 type: object features: description: System automation capabilities and sponsorship_lifecycle.enabled. type: object additionalProperties: true starter_templates: type: array items: description: >- Featured configured starter blueprint, only returned on an unfiltered empty list. type: object additionalProperties: true 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 next_page_url: description: Next-page URL, or null. type: string example: Example nullable: true prev_page_url: description: Previous-page URL, or null. type: string example: Example nullable: true 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 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.