Skip to main content
The Gratona API lets integrations manage donor and recipient records, donations, commitments, programs, and related fundraising workflows.

​
Get Started

Generate an API key from Settings → Account Settings → Developer Settings in the Gratona dashboard. Send it in the X-HYS-API-Key header when calling protected admin endpoints:
The full key is shown once when created. Give it a descriptive name, store it securely, and revoke it from Developer Settings when it is no longer needed. Passport bearer tokens are also accepted on protected admin endpoints. Public checkout and portal sign-in endpoints have different authentication requirements. Read the API reference introduction and the individual endpoint before making a request.

​
Response Statuses

  • 200 or 201: The request succeeded.
  • 202: Work was accepted for asynchronous processing.
  • 401 or 403: Authentication or access was refused.
  • 404: The requested resource was not available.
  • 409: The request conflicts with the current state; follow the endpoint’s retry or recovery instructions.
  • 410: The operation has been retired.
  • 422: Request validation failed.
  • 429: Too many requests; retry according to the response headers.
Each operation documents its request fields, response shape, and applicable statuses.