# NudgeForMe Developer Docs

> Index of the NudgeForMe Developer Docs documentation.

## Guides

- [NudgeForMe Developer Platform](https://nudge.documentationai.com/introduction.md): Connect automations and AI assistants to your existing follow-up conversations.
- [REST API quickstart](https://nudge.documentationai.com/quickstart.md): Generate a scoped developer key and call NudgeForMe from your application.
- [Authentication and authorization](https://nudge.documentationai.com/authentication.md): Developer API keys, OAuth, regional endpoints, scopes and revocation.
- [Create and manage API keys](https://nudge.documentationai.com/guides/api-keys.md): Issue a least-privilege NudgeForMe REST API key.
- [Safely monitor and draft follow-ups](https://nudge.documentationai.com/guides/draft-workflow.md): Add an existing sent thread to Nudge and generate a human-reviewable follow-up draft.
- [Integrate ChatGPT and Claude with MCP](https://nudge.documentationai.com/guides/mcp.md): Connect AI assistants to NudgeForMe through OAuth-protected remote MCP.
- [Connect n8n](https://nudge.documentationai.com/guides/n8n.md): Use NudgeForMe REST in n8n workflows.
- [Errors, limits and idempotency](https://nudge.documentationai.com/guides/errors-limits.md): Handle REST and MCP responses safely.

## API Reference

- [REST API reference](https://nudge.documentationai.com/reference/rest.md): Available v1 REST endpoints, parameters and required permissions.
- [List accessible workspaces](https://nudge.documentationai.com/api/get-workspaces.md)
- [List accessible connected mailboxes](https://nudge.documentationai.com/api/get-mailboxes.md)
- [Find previously sent conversations](https://nudge.documentationai.com/api/get-conversations.md): Search existing sent messages. Does not discover new prospect email addresses.
- [Get watched thread details and follow-up timestamps](https://nudge.documentationai.com/api/get-conversations-details.md): Does not expose full email bodies.
- [Watch an already-sent thread](https://nudge.documentationai.com/api/post-conversations-watch.md): Requires Draft mode; never sends email. Pass requestId in the JSON body or an Idempotency-Key header.
- [List follow-up opportunities](https://nudge.documentationai.com/api/get-opportunities.md)
- [Get watched thread follow-up status](https://nudge.documentationai.com/api/get-followups-status.md)
- [Pause further follow-up monitoring](https://nudge.documentationai.com/api/post-followups-pause.md)
- [Create a draft, never send](https://nudge.documentationai.com/api/post-drafts.md): Requires Draft mode and a unique request identifier. Research availability depends on plan and configured integrations.

## Use Cases

- [Integration use cases](https://nudge.documentationai.com/use-cases/overview.md): Practical automation workflows with NudgeForMe REST and MCP.
- [Sales follow-up workflow](https://nudge.documentationai.com/use-cases/sales.md): Recover stalled prospect conversations from a CRM or enrichment tool.
- [Agency reporting and client separation](https://nudge.documentationai.com/use-cases/agency.md): Monitor follow-up opportunities without leaking client conversations.
- [Operations and vendor follow-ups](https://nudge.documentationai.com/use-cases/operations.md): Track open requests and get reviewable draft reminders.