> ## 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 all entities for a program (legacy unpaginated) > Returns every entity for the given program via `Entity::getEntities()`. Pre-dates the paginated `showAllEntitiesAjax` listing — kept for legacy admin UIs and CSV-style exports that need the full set in one shot. When the underlying `getEntities()` call signals an error in its return shape, the handler returns that error verbatim. Requires permission: `manage_programs`. ## OpenAPI ````yaml post /admin/show_all_entities 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: /admin/show_all_entities: post: tags: - Entities summary: List all entities for a program (legacy unpaginated) description: >- Returns every entity for the given program via `Entity::getEntities()`. Pre-dates the paginated `showAllEntitiesAjax` listing — kept for legacy admin UIs and CSV-style exports that need the full set in one shot. When the underlying `getEntities()` call signals an error in its return shape, the handler returns that error verbatim. Requires permission: `manage_programs`. operationId: e65ee31b033f733a9ea0e20411a0daf9 requestBody: required: true content: application/json: schema: required: - program_id - trashed - client_id properties: program_id: description: 'Program whose entities to list. Validation: `required`.' type: integer example: 11 trashed: description: >- When true, includes archived entities. Validation: `required`. type: boolean example: false client_id: description: 'Owning client (multi-tenant scope). Validation: `required`.' type: integer example: 207 type: object responses: '200': description: >- Entity list (or pass-through error envelope from `Entity::getEntities()`). content: application/json: schema: properties: data: type: array items: $ref: '#/components/schemas/Entity' type: object '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '422': description: Validation error content: application/json: schema: $ref: '#/components/schemas/ValidationErrorResponse' security: - bearerAuth: [] - apiKeyAuth: [] components: schemas: Entity: title: Entity description: >- A sponsorship recipient — the 'who/what' a donor sponsors. Entities can represent children, families, animals, projects, or any other sponsorable thing depending on the program. Like donors, entities have standardized columns plus arbitrary `json_fields` defined by the program's `Hysform`. Donations target an entity through the historical `donation.designation` column. required: - id - client_id - program_id properties: id: description: Internal entity ID. type: integer format: int64 example: 4711 client_id: description: Owning Gratona client (multi-tenant scope). type: integer format: int64 example: 207 program_id: description: >- Program this entity belongs to. The program's `hysform_id` defines which custom fields appear in `json_fields`. type: integer format: int64 example: 11 status: description: >- Sponsorship status — typically `'0'` = unsponsored, `'1'` = sponsored. Stored as a string for historical reasons. type: string example: '0' nullable: true is_visible: description: Whether the entity is shown on public-facing sponsorship listings. type: boolean example: true is_featured: description: Whether the entity is highlighted on the public sponsorship page. type: boolean example: false json_fields: description: >- Arbitrary custom fields keyed by the program's HysForm. Common keys vary by client (e.g. `name`, `birthdate`, `country`, `bio`). Use the program's hysform definition to interpret them. type: object nullable: true additionalProperties: true batch_id: description: Set when the entity was created via CSV import. type: integer format: int64 example: null nullable: true created_at: type: string format: date-time example: '2025-09-01T14:00:00Z' updated_at: type: string format: date-time example: '2025-12-30T09:12:00Z' deleted_at: type: string format: date-time example: null nullable: true 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 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 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.