Developer API keys

Developer keys are for server-side REST integrations. They are separate from Gmail/Outlook provider credentials and from OAuth tokens used by ChatGPT.

Create a key

1. Sign into NudgeForMe using a verified email account.
2. Go to Settings → Developer API as the organization owner or authorized administrator.
3. Enter a descriptive name, e.g. n8n – weekly follow-up report.
4. Choose scopes. For reporting, select nudge.mailboxes.read and nudge.conversations.read.
5. Optionally restrict the key to one workspace.
6. Select an expiry (up to 365 days).
7. Create the key, copy it once, and store it in a protected credential manager.

The key looks like ndg_live_<id>.<secret>. Never paste a real key into a support ticket or publicly shared workflow.

Test your key

curl -i "https://app.nudgeforme.com/api/v1/mailboxes" \
  -H "Authorization: Bearer YOUR_KEY"

For Europe, substitute https://europe.nudgeforme.com.

Rotate a key

Create a replacement key with the same or narrower scopes, update the application credential, verify requests, and revoke the original. The server does not reveal previously issued key secrets.

Revoke access

Open Settings → Developer API, select the key, and revoke it. Revocation is effective immediately. Key authentication also rejects expired keys and checks that the issuing user remains eligible to administer the organization.

Scope examples

Important limitations

Developer keys do not work at /mcp. There is no REST endpoint for generating API keys anonymously; they are managed through authenticated NudgeForMe Settings. Keys cannot send emails.