# Docs - Guides - **Get started** - [Introduction](/guides): What the Workwae API does, the concepts it is built on, and which guide covers each task. - [Quickstart](/guides/quickstart): Create an API key, make a first call, connect a mailbox, read its mail and follow its events. - [Authentication and API keys](/guides/api-keys): Authenticate requests with an API key or account token, choose scopes, limit keys to accounts, and rotate or revoke them. - [TypeScript SDK](/guides/sdk): Install @workwae/sdk, call the API with typed methods, and use its pagination, error and webhook helpers. - **API basics** - [Errors](/guides/errors): The error body, how to handle refusals, request ids for support, and every error reason grouped by HTTP status. - [Pagination](/guides/pagination): Page through list operations with limit and cursor, or let the SDK's paginate helper follow the cursors for you. - [Rate limits and plan limits](/guides/rate-limits): Request rate limits and their headers, retrying 429 and 503, plan limits and modules, daily sends, and reading usage. - [Idempotency](/guides/idempotency): Retry a POST safely with an Idempotency-Key, so a send or create that may have gone through never runs twice. - **Accounts and mail** - [Connect flows](/guides/connect): Connect Google, Microsoft and IMAP mailboxes through a hosted page, your own UI or an existing refresh token, and reconnect them. - [IMAP and SMTP](/guides/imap): Connect any IMAP mailbox with a password, find its servers, add CalDAV and CardDAV, and read Google or Microsoft over IMAP. - [Organization connections](/guides/organizations): Authorize a Google Workspace or Microsoft 365 domain once, add its mailboxes as accounts, and open Microsoft 365 shared mailboxes. - [Read mail](/guides/mail): List mailboxes, list and search messages, read bodies, threads and attachments, and change flags, folders and labels. - **Sending mail** - [Sending mail](/guides/sending): Queue a message through the outbox, follow its delivery, schedule it, and undo or cancel it. - [Drafts](/guides/drafts): Create drafts in the user's mailbox, edit them, and send them through the outbox. - [Mail merge](/guides/mail-merge): Send up to 100 personalized messages in one call, each rendered and queued for its own recipient. - [Tracking and unsubscribes](/guides/tracking): Track opens and clicks on sent mail, and add one-click unsubscribe to bulk mail. - [Templates](/guides/templates): Store Handlebars or Markdown content, preview it, and use it in sends, drafts and mail merges. - [Suppression lists](/guides/suppressions): Keep unsubscribed, bounced and opted-out addresses out of bulk mail, and review opt-outs found in replies. - [Email validation](/guides/email-validation): Check whether addresses can receive mail before you send, and suppress the ones that cannot. - **Calendar and contacts** - [Calendar](/guides/calendar): List and manage calendars and events, answer invitations and find a time when attendees are free. - [Scheduling links and bookings](/guides/scheduling): Offer bookable slots across one or more accounts' calendars, book them for invitees and cancel bookings. - [Meetings](/guides/meetings): Create Zoom and Webex meetings with calendar events, hosted through a per-user grant or a server app. - [Contacts](/guides/contacts): List, search, create and change an account's contacts on Google, Microsoft 365 and CardDAV, and read their photos. - **Events and webhooks** - Events - [Events](/guides/events): What a Workwae event contains, how events reach you, how long they are kept, and every event type. - [Account events](/guides/events/accounts): Events for account lifecycle, data exports, meeting service connections and webhook tests, with sample payloads. - [Mail events](/guides/events/mail): Events for mailboxes, messages, sends, tracking and suppressions, with the message object and sample payloads. - [Calendar and contact events](/guides/events/calendar-and-contacts): Events for calendars, calendar events, bookings and contacts, with sample payloads. - [Change feed](/guides/changes): Poll GET /v1/changes with a cursor to read every Workwae event in order, as an alternative to webhooks. - [Webhooks](/guides/webhooks): Create an endpoint that receives Workwae events as signed HTTPS POSTs, and choose which events it gets. - [Webhook signatures](/guides/webhook-signatures): Verify that each webhook delivery came from Workwae, and rotate an endpoint's signing secret without downtime. - [Webhook delivery](/guides/webhook-delivery): How Workwae retries failed deliveries, and how to inspect the delivery log, replay events and send test events. - **AI and agents** - [AI](/guides/ai): Classify replies to the mail you send, handle detected opt-outs, and draft email text with AI. - MCP server - [MCP server](/guides/mcp): Connect an AI agent to the Workwae MCP server with an API key or OAuth, and pick which clients and scopes to use. - [Tools and prompts](/guides/mcp/tools): The MCP server's tools by scope, how they choose an account, and their mail, calendar, contact and prompt options. - [Sending safely](/guides/mcp/safe-sending): How the MCP server confirms sends, how the send policy limits agents, and how untrusted mail text reaches the model. - [MCP for your users](/guides/mcp/for-your-users): Give each of your users an MCP key bound to their own account, minted through the API or a hosted connect session. - [MCP Apps and Events](/guides/mcp/apps-and-events): The message review and meeting picker views for MCP Apps hosts, and MCP Events subscriptions that push new mail and calendar changes. - [Developer toolset](/guides/mcp/developer-toolset): A second MCP server for coding agents that build or debug a Workwae integration, from sync health to the API reference. - **Administration** - [Exports](/guides/exports): Export the whole tenant or one account as a .tar.gz archive, wait for it to finish, then download and verify it. - [Audit log](/guides/audit-log): List the changes made in your tenant through the API, the console and MCP, and your members' sign-ins and account security changes, filtered by actor, action, account, outcome and time. - API reference - [Introduction](/reference): Base URL, authentication, errors, pagination, idempotency and limits that every Workwae API operation shares. - **Accounts** - [Accounts](/reference/accounts): List, update, sync and delete connected accounts, connect IMAP mailboxes and token imports, and mint account tokens. - [Connect](/reference/connect): Create hosted connect sessions, read their outcome and start a headless OAuth flow. - [Hosted pages](/reference/hosted-pages): The calls behind Workwae's hosted connect pages. Your backend creates the session; these routes are used by the page itself. - [Organization connections](/reference/organization-connections): Register Google Workspace delegation or Microsoft 365 app-only access, then list the directory and add mailboxes as accounts. - [Shared mailboxes](/reference/shared-mailboxes): Open a Microsoft 365 shared mailbox with an account's grant. - [Identities](/reference/identities): The addresses an account may send as, their signatures, and the account's mail settings. - [MCP keys](/reference/mcp-keys): Mint, list and revoke MCP keys for one account's end user. - **Mail** - [Mail](/reference/mail): Mailboxes, messages, threads, search, attachments and sending. Everything is addressed under an account. - [Templates](/reference/templates): Handlebars and Markdown templates, and rendering one without sending. - [Suppressions](/reference/suppressions): Suppression lists, the addresses on them, and the opt-outs detected in replies that await review. - [Email validation](/reference/email-validation): Check whether addresses can receive mail, and suppress the ones that cannot. - **Calendar and contacts** - [Calendar](/reference/calendar): Calendars, events and recurring series, invitation replies, and finding free time. - [Scheduling](/reference/scheduling): Scheduling links, their open slots, and bookings. - [Meeting connections](/reference/meeting-connections): An account's Zoom and Webex connections, and the hosted flow that creates them. - [Contacts](/reference/contacts): List, search, write and photo-download contacts across Google, Microsoft 365 and CardDAV. - **Events** - [Webhooks](/reference/webhooks): Endpoints, signing secrets, the delivery log, test events and replays. - [Changes](/reference/changes): The change feed: every event of the tenant, read with a cursor. - **AI** - [AI](/reference/ai): Draft email text with the AI gateway. - **Workspace** - [Settings](/reference/settings): Tenant settings: redirect URIs, tracking defaults, retention, AI and the MCP send policy. - [OAuth apps](/reference/oauth-apps): Register your own Google and Microsoft OAuth apps for the connect flow. - [Meeting apps](/reference/meeting-apps): Register Zoom and Webex server apps that host meetings for your accounts. - [Usage](/reference/usage): The tenant's plan, limits and per-day usage. - [Exports](/reference/exports): Export a tenant or one account as an archive, then download or delete it. - [Audit log](/reference/audit-log): Read the mutating requests made against the tenant. - [Changelog](/changelog): User-visible changes to the API, webhooks and the SDK, newest first.