Skip to main content
API keys let your team connect Overflow to the tools your ministry already uses, so gifts, donors, and reporting stay in sync without extra admin work.

​
Prerequisites

  • Developer write access in your nonprofit dashboard. Without write access you can view keys but not create, edit, or revoke them.
  • A safe place to store secrets, such as a password manager or your integration’s secret manager.

​
Key concepts

  • API key: The secret credential an integration uses to call the Overflow API.
  • Client ID: The public identifier for the integration. It is safe to share with the tool you are connecting.
  • Permissions: The scope of what a key can do. Choose from:
    • READ_ONLY for read-only access.
    • READ_WRITE for read and write access.
    • WRITE_ONLY for write-only access.
  • One-time secret: The API key value is shown only once, right after you create it. If you lose it, you must create a new key.

​
Create an API key

1

Open API Keys

In the nonprofit dashboard, go to Developers → API Keys. You see the list of existing keys and a New API key button in the top right.
2

Start a new key

Select New API key to open the New API keys window.
3

Name the key and set permissions

Enter a short, descriptive API key name that tells your team what the key is for, such as the tool or workflow it powers. Choose the Permissions the integration needs. The default is READ_ONLY, which is the safest starting point.
4

Generate the key

Select Generate keys. The window switches to Your API keys and shows the new API key alongside its Client ID.
5

Save the secret

The API key value is copied to your clipboard automatically. Paste it into your password manager or the tool you are connecting right away. You can also copy the API key or Client ID again from this screen. Once you close the window, the API key value cannot be viewed again.
6

Finish

Select Done to close the window. The new key appears at the top of the API keys list, and a confirmation message lets you know it is ready to use.

​
Review existing keys

The API keys list gives you one place to see every credential in use. For each key it shows:
  • Name of the key.
  • API key, shown as a masked preview so the value stays protected.
  • Client ID, shortened for readability, with a copy button.
  • Permissions the key was granted.
  • Created date, sorted newest first by default.
  • Last used, so you can spot keys that no integration is calling anymore.
You can sort by Name, Created, or Last used to find the key you need. The list shows ten keys per page.

​
Edit a key

Use edit when a key needs a clearer name or a different level of access.
  1. From the row action menu next to the key, select Edit API key.
  2. Update the API key name or Permissions. The Client ID stays the same and cannot be changed.
  3. Save your changes. The list refreshes with the updated details.

​
Revoke a key

Revoke a key as soon as you suspect it has been shared in the wrong place, or when an integration is no longer in use.
  1. From the row action menu, select Revoke API key. You can also revoke a key from inside the edit window.
  2. Confirm the action.
Revoking a key immediately cuts off access for any tool using it, and the action cannot be undone. If you still need the integration, create a new key and update the tool with the new credentials.

​
FAQ

No. The API key value is shown one time only, right after you create it. If you did not save it, revoke the key and create a new one.
Creating, editing, and revoking keys require Developer write access. If your role does not include write access, the row actions appear as a dash. Ask an admin on your team to grant the permission or make the change for you.
READ_ONLY lets an integration pull data out of Overflow. WRITE_ONLY lets an integration send data into Overflow without reading anything back. READ_WRITE allows both. Choose the smallest scope the integration needs.
You can create as many keys as your team needs. A common practice is one key per integration, so you can revoke a single key without affecting other tools.

​
Next step

Once your key is ready, hand it and the Client ID to the tool you are connecting, then explore the Overflow API Reference to see the endpoints your integration can call.
Last modified on October 6, 2026