Skip to main content

API keys

Create a read or write key for the Sharity REST API.

A
Written by Antonio Ryckman

Spark and above. Go to Integrations → API keys.

  1. Create a key and choose scopes: read, write, or both.

  2. Copy the secret immediately — it is shown once.

  3. Store it in your server environment, never in a public repo or browser JavaScript.

Send Authorization: Bearer <your_key> on every request to /api/v1 on your Sharity dashboard host.

  • Read — list campaigns, donations, and supporters

  • Write — upsert supporters, add list membership, and post already-paid external orders

Call GET /api/v1/me first to confirm the org and scopes. Rotate a key by creating a new one and deleting the old key after you switch.

Related Articles
Did this answer your question?