> ## 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.

# Get a trip with setup details

> Returns the trip profile, program bindings, cover image, budget items, tasks and fundraising totals in the authenticated organization.



## OpenAPI

````yaml get /admin/trips/{id}
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/trips/{id}:
    get:
      tags:
        - Trips
      summary: Get a trip with setup details
      description: >-
        Returns the trip profile, program bindings, cover image, budget items,
        tasks and fundraising totals in the authenticated organization.
      operationId: docTripShowGET
      parameters:
        - name: id
          in: path
          description: >-
            Record ID within the organization and any parent resource in this
            route.
          required: true
          schema:
            type: integer
          example: 123
      responses:
        '200':
          description: Get a trip with setup details response.
          content:
            application/json:
              schema:
                properties:
                  id:
                    type: integer
                  name:
                    type: string
                  slug:
                    type: string
                  status:
                    type: string
                  fundraising_goal:
                    type: number
                  total_raised:
                    type: number
                  progress_percent:
                    type: number
                  participant_count:
                    type: integer
                  is_sample_trip:
                    type: boolean
                  sample_seed_version:
                    type: integer
                    nullable: true
                  created_at:
                    type: string
                    format: date-time
                  updated_at:
                    type: string
                    format: date-time
                  destination:
                    type: string
                    nullable: true
                  start_date:
                    type: string
                    format: date
                    nullable: true
                  end_date:
                    type: string
                    format: date
                    nullable: true
                  description:
                    type: string
                    nullable: true
                  cover_image_id:
                    type: integer
                    nullable: true
                  total_budget:
                    type: number
                  default_participant_goal:
                    type: number
                  suggested_participant_goal:
                    type: number
                  settings:
                    description: >-
                      Trip-specific settings merged with saved settings on
                      update. Binding IDs must belong to this organization.
                      background_check_validity_months is validated but stripped
                      before storage; Checkr owns validity. sample_seed is
                      preserved and cannot be supplied by callers.
                    properties:
                      donor_hysform_id:
                        description: 'Validation: `nullable|integer`.'
                        type: integer
                        nullable: true
                      program_setting_id:
                        description: 'Validation: `nullable|integer`.'
                        type: integer
                        nullable: true
                      emailset_id:
                        description: 'Validation: `nullable|integer`.'
                        type: integer
                        nullable: true
                      show_donor_names:
                        description: >-
                          Validation:
                          `nullable|in:full,first_initial,anonymous`.
                        type: string
                        enum:
                          - full
                          - first_initial
                          - anonymous
                          - null
                        nullable: true
                      default_participant_goal_mode:
                        description: >-
                          Validation:
                          `nullable|in:equal_split,fixed_amount,manual`.
                        type: string
                        enum:
                          - equal_split
                          - fixed_amount
                          - manual
                          - null
                        nullable: true
                      default_participant_goal_amount:
                        description: 'Validation: `nullable|numeric|min:0|max:999999999.99`.'
                        type: number
                        maximum: 999999999.99
                        minimum: 0
                        nullable: true
                      required_esign_templates:
                        type: array
                        items:
                          type: string
                          maxLength: 255
                        nullable: true
                      background_check_validity_months:
                        description: 'Validation: `nullable|integer|min:1|max:120`.'
                        type: integer
                        maximum: 120
                        minimum: 1
                        nullable: true
                      background_check_cost_mode:
                        description: >-
                          Validation:
                          `nullable|in:org,organization,participant,candidate`.
                        type: string
                        enum:
                          - org
                          - organization
                          - participant
                          - candidate
                          - null
                        nullable: true
                      show_donation_amounts:
                        description: 'Validation: `nullable|boolean`.'
                        type: boolean
                        nullable: true
                      allow_recurring_donations:
                        description: 'Validation: `nullable|boolean`.'
                        type: boolean
                        nullable: true
                      completed_accept_donations:
                        description: 'Validation: `nullable|boolean`.'
                        type: boolean
                        nullable: true
                      show_participant_goals:
                        description: 'Validation: `nullable|boolean`.'
                        type: boolean
                        nullable: true
                      allow_anonymous_donations:
                        description: 'Validation: `nullable|boolean`.'
                        type: boolean
                        nullable: true
                      sync_budget_to_goal:
                        description: 'Validation: `nullable|boolean`.'
                        type: boolean
                        nullable: true
                      allow_participant_visibility_opt_out:
                        description: 'Validation: `nullable|boolean`.'
                        type: boolean
                        nullable: true
                      request_to_join_enabled:
                        description: 'Validation: `nullable|boolean`.'
                        type: boolean
                        nullable: true
                    type: object
                    nullable: true
                    additionalProperties: true
                  program_binding:
                    properties:
                      program_id:
                        type: integer
                        nullable: true
                      donor_hysform_id:
                        type: integer
                        nullable: true
                      program_setting_id:
                        type: integer
                        nullable: true
                      emailset_id:
                        type: integer
                        nullable: true
                    type: object
                  cover_image:
                    properties:
                      id:
                        type: integer
                      name:
                        type: string
                      url:
                        type: string
                        nullable: true
                    type: object
                    nullable: true
                  budget_items:
                    type: array
                    items:
                      $ref: '#/components/schemas/TripAdminBudgetItemDoc'
                  tasks:
                    type: array
                    items:
                      properties:
                        id:
                          type: integer
                        title:
                          type: string
                        description:
                          type: string
                          nullable: true
                        due_date:
                          type: string
                          format: date
                          nullable: true
                        is_required:
                          type: boolean
                        requires_document:
                          type: boolean
                        requires_approval:
                          type: boolean
                        sort_order:
                          type: integer
                      type: object
                type: object
        '401':
          description: Missing or invalid bearer token or API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
        '403':
          description: >-
            The caller lacks the required permission, resource access or feature
            availability.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: >-
            The organization-owned resource or parent was not found or is not
            available for this operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
      security:
        - bearerAuth: []
        - apiKeyAuth: []
components:
  schemas:
    TripAdminBudgetItemDoc:
      properties:
        id:
          type: integer
        trip_id:
          type: integer
        category:
          type: string
        description:
          type: string
          nullable: true
        amount:
          type: number
        sort_order:
          type: integer
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      type: object
    UnauthorizedResponse:
      title: UnauthorizedResponse
      description: >-
        Returned with HTTP 401 when the request lacks a valid Passport bearer
        token, a valid `X-HYS-API-Key`, or a valid session. The body is the
        simple `{message, status}` envelope emitted by `AuthenticateApiOrKey`.
      required:
        - message
        - status
      properties:
        message:
          description: >-
            Always the literal string `Unauthorized` from the `auth.api_or_key`
            middleware. Login endpoints return `Invalid Credentials` instead.
          type: string
          example: Unauthorized
        status:
          type: string
          example: error
      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
  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.