> ## 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. # Paginated list of message threads + donor address book > Returns the recipient's message inbox (sent + received roots), a bounded initial donor address book (`donor_options`), the total number of emailable donors, and a flag indicating whether new messages require admin approval before delivery. More donor options are searched through the donor-options endpoint. Returns 403 when messaging is disabled. ## OpenAPI ````yaml get /frontend/recipient-portal/{client_id}/{session_id}/messages 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 sponsorship relationships, lifecycle transitions, and sponsorship-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: Client description: Client - name: Email Settings description: Email Settings - name: Admin Dashboard description: Admin Dashboard - name: Historical Archived Updates description: Historical Archived Updates - name: Team & access description: Team & access - name: Files description: Files - name: Wrapped description: Wrapped - name: Donor SignUp description: Donor SignUp - name: Frontend description: Frontend - name: User description: User paths: /frontend/recipient-portal/{client_id}/{session_id}/messages: get: tags: - Recipient Portal summary: Paginated list of message threads + donor address book description: >- Returns the recipient's message inbox (sent + received roots), a bounded initial donor address book (`donor_options`), the total number of emailable donors, and a flag indicating whether new messages require admin approval before delivery. More donor options are searched through the donor-options endpoint. Returns 403 when messaging is disabled. operationId: da3810953a8617e59a68518af6ae75be parameters: - name: client_id in: path required: true schema: type: integer format: int64 example: 207 - name: session_id in: path required: true schema: type: string - name: page in: query required: false schema: type: integer default: 1 minimum: 1 - name: per_page in: query required: false schema: type: integer default: 10 maximum: 50 minimum: 1 responses: '200': description: Inbox + address book. content: application/json: schema: properties: status: type: string example: success data: type: array items: properties: message_id: type: integer subject: type: string snippet: type: string status: type: string type: object pagination: type: object donor_options: type: array items: properties: id: type: integer label: type: string email: type: string format: email type: object mailable_donor_count: type: integer approval_required: type: boolean recipient: type: object program: type: object client: type: object type: object '401': description: No active session. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '403': description: Messaging disabled. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - sessionIdAuth: [] components: schemas: 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 securitySchemes: sessionIdAuth: type: apiKey description: >- Legacy session-id header retained for backwards compatibility with older first-party clients. New integrations should prefer bearerAuth or apiKeyAuth. name: session_id in: header ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.