> ## 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 available automation primitives > Lists registered operations filtered by credential scopes, current Gratona permissions and feature availability. Each summary links to a complete input/output schema and invocation endpoint. Discovery is read-only and is not authorization to execute a mutation. ## OpenAPI ````yaml get /primitives 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: /primitives: get: tags: - Automation summary: List available automation primitives description: >- Lists registered operations filtered by credential scopes, current Gratona permissions and feature availability. Each summary links to a complete input/output schema and invocation endpoint. Discovery is read-only and is not authorization to execute a mutation. operationId: ef76e299bf6e60ac0eae4e84eb3bbee4 responses: '200': description: Caller-visible primitive catalog. content: application/json: schema: properties: success: description: The caller-visible catalog was generated. type: boolean example: true data: description: Primitive summaries filtered by the caller context. properties: primitives: description: Available operations. type: array items: $ref: '#/components/schemas/V3PrimitiveSummary' by_category: description: >- The same summaries grouped by category. An empty map is serialized as an empty array. oneOf: - type: object additionalProperties: type: array items: $ref: '#/components/schemas/V3PrimitiveSummary' - type: array items: {} maxItems: 0 count: description: Number of visible operations. type: integer example: 20 type: object meta: description: Discovery context. properties: description: description: Catalog purpose. type: string example: Available primitives for agent invocation scopes_applied: description: API-key scopes applied to this discovery request. type: array items: type: string type: object type: object '401': description: Authentication is missing, invalid or no longer eligible. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' security: - bearerAuth: [] - apiKeyAuth: [] servers: - url: https://api.gratona.com/v3 description: Gratona V3 automation API components: schemas: V3PrimitiveSummary: required: - name - description - category - is_mutation - required_scope - href - invoke_href properties: name: description: Registered primitive identifier. type: string example: donors.list description: description: Business purpose of the operation. type: string example: List donors in the authenticated organization. category: description: Operation category. type: string example: donors is_mutation: description: Whether invocation changes records. type: boolean example: false required_scope: description: Credential scope for this primitive. type: string example: primitives:donors:list href: description: Relative schema URL. type: string example: /v3/primitives/donors.list/schema invoke_href: description: Relative invocation URL. type: string example: /v3/primitives/donors.list/invoke 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 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.