Skip to main content
All endpoints authenticate with an API key sent in the Authorization header. Keys are region-specific: a key only works against the regional hostname of the account that created it (see Base URL and regions).

Step 1 — Create an API key

Create a key from the API Keys page in the CMS for your region:
Copy the key when it is shown and store it in a secret manager. Keys can carry an expiry date and can be revoked from the same page.

Step 2 — Send the key on every request

Use the DAANA-API scheme:
The quotes around the key are optional. No login call, cookie, or CSRF token is needed.

Key scope

A request made with an API key acts as the user who owns the key, so it can only reach the events that user can access. A key scoped to an organisation is further limited to that organisation’s events — requesting any other event returns 403 Forbidden. A key stops working when it expires, when it is revoked, or when its owning user is deactivated.

Authorization rules per family

All families accept the same API key but apply different authorization checks:
Custom Data Export endpoints require a dedicated service user provisioned per customer. If you receive 403 Forbidden with a body like {"code":"forbidden","message":"Access forbidden: not a <namespace> client","extra":"<your-user-uuid>"}, the key you are using does not belong to the configured service user for your integration. Contact support@givergy.com to provision the right service user.

Credential handling

An API key grants read access to everything its scope allows. Treat it as a privileged secret:
  • Store it in a secret manager, not in source control or environment files committed to a repo.
  • Rotate it on a schedule and after any suspected compromise — create the new key, switch your integration over, then revoke the old one.
  • Use a separate key per integration and per environment.

Errors specific to authentication

See the full Errors page for the complete error shape and other status codes.