REST API quickstart

1. Create an API key

Sign in to NudgeForMe as a verified owner or organization administrator. Open Settings → Developer API and create a named key. Select nudge.mailboxes.read and nudge.conversations.read, an optional workspace restriction, and expiry. Copy the secret once.

2. Choose your account region

• Global: https://app.nudgeforme.com
• Europe: https://europe.nudgeforme.com

3. List workspaces

export NUDGE_BASE="https://app.nudgeforme.com"
export NUDGE_API_KEY="YOUR_DEVELOPER_KEY"

curl --fail-with-body -sS "$NUDGE_BASE/api/v1/workspaces" \
 -H "Authorization: Bearer $NUDGE_API_KEY"

4. List connected mailboxes

curl --fail-with-body -sS "$NUDGE_BASE/api/v1/mailboxes" \
 -H "Authorization: Bearer $NUDGE_API_KEY"

Pick a mailboxId from the JSON response.

5. Search existing sent conversations

curl -G --fail-with-body -sS "$NUDGE_BASE/api/v1/conversations" \
 -H "Authorization: Bearer $NUDGE_API_KEY" \
 --data-urlencode "mailboxId=MAILBOX_ID" \
 --data-urlencode "search=proposal" \
 --data-urlencode "limit=10"

This finds previously sent conversations, not brand-new prospects.

6. Explore safe write operations

The three POST operations require write scopes and a unique Idempotency-Key header. Read the draft workflow before trying them.

Next steps

Authentication · REST reference · n8n guide · MCP integration