> ## 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 an exposed model schema > Returns field types, fillable and hidden metadata, casts and known relationships for one exposed model. Scoped API keys require schema:read (or a matching wildcard). The field and relationship maps reflect the deployed database/model definition and contain no record values. ## OpenAPI ````yaml get /schema/models/{name} 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: /schema/models/{name}: get: tags: - Schema summary: Get an exposed model schema description: >- Returns field types, fillable and hidden metadata, casts and known relationships for one exposed model. Scoped API keys require schema:read (or a matching wildcard). The field and relationship maps reflect the deployed database/model definition and contain no record values. operationId: d8b20556b3aae49ec1ff211ca90ae2e1 parameters: - name: name in: path description: Exposed model name from the model catalog. required: true schema: type: string pattern: ^[a-z_]+$ example: donor responses: '200': description: Model metadata. content: application/json: schema: properties: success: description: The model is exposed. type: boolean example: true data: $ref: '#/components/schemas/V3ModelSchema' type: object '401': description: Authentication is missing, invalid or no longer eligible. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '403': description: >- The scoped API key does not grant schema:read or workspace access is unavailable. content: application/json: schema: $ref: '#/components/schemas/V3AccessDenied' '404': description: The requested model is not exposed. content: application/json: schema: $ref: '#/components/schemas/V3DiscoveryError' security: - bearerAuth: [] - apiKeyAuth: [] servers: - url: https://api.gratona.com/v3 description: Gratona V3 automation API components: schemas: V3ModelSchema: properties: name: description: Exposed model identifier. type: string example: donor class: description: Laravel model class. type: string example: App\\Models\\Donor table: description: Database table associated with the model. type: string example: donors description: description: Business purpose of this record type. type: string example: A person or organization that donates. tenant_scoped: description: Whether the model has a client_id field. type: boolean example: true soft_deletes: description: Whether the model uses Laravel soft deletes. type: boolean example: true timestamps: description: Whether the model maintains timestamps. type: boolean example: true fields: description: Map of column names to field metadata. type: object additionalProperties: properties: type: description: Discovery type mapped from the database column. type: string example: integer database_type: description: Raw database column type. type: string example: bigint fillable: description: Whether the field appears in the model fillable list. type: boolean example: true hidden: description: Whether the field is hidden from model serialization. type: boolean example: false cast: description: Configured Laravel cast, when present. type: string example: integer nullable: true type: object relationships: description: >- Known or introspected model relationships. An empty map is serialized as an empty array. oneOf: - type: object additionalProperties: properties: type: description: Relationship kind. type: string example: belongsTo method: description: Introspected method name, when available. type: string example: household model: description: Known related model label, when available. type: string example: Household pivot: description: Known pivot table, when applicable. type: string example: donor_entity type: object - type: array items: {} maxItems: 0 fillable: description: Mass-assignable field names. type: array items: type: string hidden: description: Fields hidden from standard serialization. type: array items: type: string casts: description: >- Field names mapped to their configured Laravel casts. An empty map is serialized as an empty array. oneOf: - type: object additionalProperties: type: string - type: array items: {} maxItems: 0 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 V3AccessDenied: description: >- Scope/primitive denials or the authentication middleware workspace-access denial. oneOf: - $ref: '#/components/schemas/V3DiscoveryError' - $ref: '#/components/schemas/ErrorResponse' V3DiscoveryError: description: >- V3 discovery errors; primitive failures may additionally include data, warnings and meta. required: - success - errors properties: success: description: False when discovery or authorization fails. type: boolean example: false errors: description: Structured operation errors. type: array items: properties: code: description: Machine-readable failure code. type: string example: INSUFFICIENT_SCOPE message: description: Human-readable explanation. type: string example: Required scope is missing. required_scope: description: Required scope when reported by the guard. type: string example: schema:read available_scopes: description: Credential scopes when reported by the schema guard. type: array items: type: string required_permission_groups: description: Permission alternatives grouped by required access boundary. type: array items: type: array items: type: string 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.