Workwae API V1 API

Email, calendar and contacts sync for Gmail and Microsoft 365 accounts, and email sync for

Operations 141

GET /v1/accounts List accounts #
POST /v1/accounts Connect an account from an existing refresh token #
GET /v1/accounts/{accountId} Get an account #
PATCH /v1/accounts/{accountId} Update an account #
DELETE /v1/accounts/{accountId} Delete an account #
POST /v1/accounts/{accountId}/sync Sync an account now #
POST /v1/accounts/{accountId}/tokens Mint an account-scoped token #
POST /v1/accounts/{accountId}/mcp-keys Mint an MCP key for an account's user #
GET /v1/accounts/{accountId}/mcp-keys List an account's MCP keys #
DELETE /v1/accounts/{accountId}/mcp-keys/{keyId} Revoke an MCP key #
GET /v1/accounts/{accountId}/mailboxes List mailboxes (folders or labels) #
POST /v1/accounts/{accountId}/mailboxes Create a mailbox (folder or label) #
PATCH /v1/accounts/{accountId}/mailboxes/{mailboxId} Rename or move a mailbox #
DELETE /v1/accounts/{accountId}/mailboxes/{mailboxId} Delete a mailbox #
GET /v1/accounts/{accountId}/messages List messages, newest first #
GET /v1/accounts/{accountId}/messages/{messageId} Get a message with its body #
PATCH /v1/accounts/{accountId}/messages/{messageId} Change flags, move, or change labels #
DELETE /v1/accounts/{accountId}/messages/{messageId} Delete a message #
GET /v1/accounts/{accountId}/messages/{messageId}/raw Download the message as RFC 5322 (message/rfc822) #
GET /v1/accounts/{accountId}/messages/{messageId}/attachments/{attachmentId} Download an attachment #
GET /v1/accounts/{accountId}/search/messages Search messages #
GET /v1/accounts/{accountId}/threads List threads, latest activity first #
GET /v1/accounts/{accountId}/threads/{threadId} Get a thread with its messages, oldest first #
PATCH /v1/accounts/{accountId}/threads/{threadId} Mark a thread read or unread, or move it #
DELETE /v1/accounts/{accountId}/threads/{threadId} Move a thread to Trash #
POST /v1/accounts/{accountId}/drafts Create a draft #
PUT /v1/accounts/{accountId}/drafts/{messageId} Replace a draft's content #
DELETE /v1/accounts/{accountId}/drafts/{messageId} Delete a draft #
POST /v1/accounts/{accountId}/drafts/{messageId}/send Send a draft #
POST /v1/accounts/{accountId}/outbox Send a message #
GET /v1/accounts/{accountId}/outbox List queued and recent sends, newest first #
GET /v1/accounts/{accountId}/outbox/{outboxId} Get a send #
DELETE /v1/accounts/{accountId}/outbox/{outboxId} Cancel a queued send #
PATCH /v1/accounts/{accountId}/outbox/{outboxId} Reschedule a queued send #
GET /v1/accounts/{accountId}/outbox/{outboxId}/tracking List a send's opens and clicks #
POST /v1/accounts/{accountId}/mail-merges Send one message per recipient (mail merge) #
GET /v1/templates List templates #
POST /v1/templates Create a template #
GET /v1/templates/{templateId} Get a template #
PATCH /v1/templates/{templateId} Update a template #
DELETE /v1/templates/{templateId} Delete a template #
POST /v1/template-renders Render a template without sending #
GET /v1/suppressions List suppression lists #
POST /v1/suppressions Create a suppression list #
PATCH /v1/suppressions/{listId} Update a suppression list #
DELETE /v1/suppressions/{listId} Delete a suppression list #
GET /v1/suppressions/{listId}/entries List suppressed addresses #
POST /v1/suppressions/{listId}/entries Suppress addresses #
DELETE /v1/suppressions/{listId}/entries/{address} Release an address #
GET /v1/suppression-reviews List opt-outs to review #
POST /v1/suppression-reviews/{reviewId}/approve Approve an opt-out #
POST /v1/suppression-reviews/{reviewId}/dismiss Dismiss an opt-out #
GET /v1/accounts/{accountId}/identities List the addresses the account may send as #
POST /v1/accounts/{accountId}/identities Add a custom identity #
PATCH /v1/accounts/{accountId}/identities/{identityId} Change an identity's signature or name #
DELETE /v1/accounts/{accountId}/identities/{identityId} Remove a custom identity #
GET /v1/accounts/{accountId}/mail-settings Get the account's mail settings #
PATCH /v1/accounts/{accountId}/mail-settings Update the account's mail settings #
GET /v1/accounts/{accountId}/calendars List calendars #
POST /v1/accounts/{accountId}/calendars Create a calendar #
PATCH /v1/accounts/{accountId}/calendars/{calendarId} Rename a calendar or change its color #
DELETE /v1/accounts/{accountId}/calendars/{calendarId} Delete a calendar #
GET /v1/accounts/{accountId}/calendar-events List events in a time range, by start #
POST /v1/accounts/{accountId}/calendar-events Create an event or a recurring series #
GET /v1/accounts/{accountId}/calendar-events/{eventId} Get an event with its body #
PATCH /v1/accounts/{accountId}/calendar-events/{eventId} Change an event, one occurrence, or a whole series #
DELETE /v1/accounts/{accountId}/calendar-events/{eventId} Delete an event, one occurrence, or a whole series #
POST /v1/accounts/{accountId}/calendar-events/{eventId}/respond Accept, tentatively accept or decline an invitation #
POST /v1/accounts/{accountId}/availability/find Find busy times and common free slots #
POST /v1/availability/find Find free slots across several accounts #
GET /v1/scheduling-links List scheduling links #
POST /v1/scheduling-links Create a scheduling link #
GET /v1/scheduling-links/{linkId} Get a scheduling link #
PATCH /v1/scheduling-links/{linkId} Update a scheduling link #
DELETE /v1/scheduling-links/{linkId} Delete a scheduling link #
GET /v1/scheduling-links/{linkId}/slots List bookable slots #
POST /v1/scheduling-links/{linkId}/bookings Book a slot #
DELETE /v1/bookings/{bookingId} Cancel a booking #
GET /v1/accounts/{accountId}/meeting-connections List an account's meeting connections #
DELETE /v1/accounts/{accountId}/meeting-connections/{service} Remove a meeting connection #
POST /v1/accounts/{accountId}/meeting-connect-sessions Create a hosted meeting connect session #
GET /v1/meeting-apps List meeting apps #
POST /v1/meeting-apps Register a meeting app #
POST /v1/meeting-apps/{appId}/test Test a meeting server app #
DELETE /v1/meeting-apps/{appId} Delete a meeting app #
GET /v1/accounts/{accountId}/contacts List or search contacts, by name #
POST /v1/accounts/{accountId}/contacts Create a contact #
GET /v1/accounts/{accountId}/contacts/{contactId} Get a contact #
PATCH /v1/accounts/{accountId}/contacts/{contactId} Change a contact #
DELETE /v1/accounts/{accountId}/contacts/{contactId} Delete a contact #
GET /v1/accounts/{accountId}/contacts/{contactId}/photo Download a contact's photo #
GET /v1/accounts/{accountId}/contact-folders List contact folders #
GET /v1/webhooks List webhook endpoints #
POST /v1/webhooks Create a webhook endpoint #
PATCH /v1/webhooks/{endpointId} Update a webhook endpoint #
DELETE /v1/webhooks/{endpointId} Delete a webhook endpoint #
POST /v1/webhooks/{endpointId}/rotate-secret Rotate the signing secret #
POST /v1/webhooks/{endpointId}/test Send a test event #
GET /v1/webhooks/{endpointId}/attempts Read the delivery log #
POST /v1/webhooks/{endpointId}/replay Replay a time range #
POST /v1/webhooks/{endpointId}/events/{eventId}/replay Replay one event #
GET /v1/webhooks/{endpointId}/failed-deliveries/count Count failed deliveries #
POST /v1/webhooks/{endpointId}/replay-failed Replay failed deliveries #
GET /v1/changes Read the change feed #
GET /v1/settings Get tenant settings #
PATCH /v1/settings Update tenant settings #
GET /v1/oauth-apps List tenant OAuth apps #
POST /v1/oauth-apps Register a tenant OAuth app #
PATCH /v1/oauth-apps/{appId} Change a tenant OAuth app: name, client secret, authority or Gmail push #
DELETE /v1/oauth-apps/{appId} Delete a tenant OAuth app #
POST /v1/connect-sessions Create a hosted connect session #
GET /v1/connect-sessions/{sessionId} Read a hosted connect session's outcome #
POST /v1/oauth-authorizations Start a headless OAuth connect #
GET /v1/org-connections List organization connections #
POST /v1/org-connections Register an organization connection #
GET /v1/org-connections/{connectionId} Get an organization connection #
PATCH /v1/org-connections/{connectionId} Update an organization connection #
DELETE /v1/org-connections/{connectionId} Delete an organization connection #
POST /v1/org-connections/{connectionId}/consent Start Microsoft admin consent #
POST /v1/org-connections/{connectionId}/test Test an organization connection #
GET /v1/org-connections/{connectionId}/directory-entries List the directory's mailboxes #
POST /v1/org-connections/{connectionId}/accounts Add mailboxes as accounts #
POST /v1/org-connections/{connectionId}/groups Add a Google Group as an account #
POST /v1/accounts/{accountId}/shared-mailboxes Open a shared mailbox with an account's grant #
POST /v1/imap-accounts Connect an IMAP/SMTP account with a password #
PATCH /v1/accounts/{accountId}/imap-settings Change an IMAP account's servers or password #
GET /v1/autoconfig Find IMAP, SMTP and DAV settings for an address #
GET /v1/hosted/connect-sessions/{token} Read a hosted connect session #
POST /v1/hosted/connect-sessions/{token}/imap-accounts Connect an IMAP account from the hosted page #
GET /v1/hosted/connect-sessions/{token}/autoconfig Find IMAP and SMTP settings from the hosted page #
GET /v1/hosted/meeting-connect-sessions/{token} Read a hosted meeting connect session #
POST /v1/exports Export the tenant or one account #
GET /v1/exports List exports, newest first #
GET /v1/exports/{exportId} Get an export #
DELETE /v1/exports/{exportId} Delete an export and its file #
GET /v1/exports/{exportId}/download Download an export (application/gzip) #
GET /v1/usage Read usage and plan limits #
POST /v1/ai/draft Draft email text with AI #
POST /v1/email-validations Validate email addresses #
GET /v1/email-validations List earlier validation results #
GET /v1/audit-log Read the audit log #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/workwae-com:workwae-api-v1-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

workwae-com-v1-openapi.json Raw ↑
{"info":{"title":"Workwae API","version":"1.0.0","description":"Email, calendar and contacts sync for Gmail and Microsoft 365 accounts, and email sync for\nany IMAP/SMTP mailbox.\n\nAuthenticate with `Authorization: Bearer wk_...` (an API key with read, write, send or admin\nscope) or, for `GET /v1/accounts/{accountId}` and the account's mail, calendar and contacts\nroutes (`/v1/accounts/{accountId}/...` under Mail, Identities, Calendar and Contacts), a\nshort-lived account token (`Bearer wat_...`) that acts with every scope on that one account.\n\nErrors answer with `{ defined, code, status, message, data? }`. `code` is the error's\nstable reason (snake_case, e.g. `plan_limit_accounts`); each reason always comes with the\nsame HTTP status; `message` is for people; `data` is present only for the reasons that\ncarry structured details (e.g. `invalid_input` lists `data.issues`). Each operation's\nresponses list the reasons it answers with, each with the condition it is answered on.\nEvery operation can also answer `invalid_input` (400), `unauthenticated` (401),\n`missing_scope`, `role_forbidden`, `account_token_forbidden`, `account_scope_forbidden`\nand `mcp_only_key` (403), `payload_too_large` (413), `rate_limited` and\n`too_many_requests` (429),\n`internal_error` (500) and `overloaded` (503).\n\nCalendar routes answer `calendar_disabled` while the account's calendar sync is off\n(`settings.calendarEnabled`), contacts routes `contacts_disabled` while its contacts sync\nis off (`settings.contactsEnabled`), and mail routes `mail_disabled` while its mail is off\n(`settings.mailEnabled`); IMAP accounts have calendar and contacts only through their CalDAV\nand CardDAV settings.\n\nEvery response carries `X-Request-Id`. Send your own (1 to 128 of `A-Z a-z 0-9 . _ : -`)\nand it is echoed back; otherwise, or when it does not fit, the API generates one. Quote it\nwhen you contact support: it names the request in our logs and in the audit log.\n\nAuthenticated `POST` operations take an `Idempotency-Key` header (1 to 255 printable ASCII\ncharacters without spaces, e.g. a UUID). The first answer to a key is kept for 24 hours for\nyour tenant: sending the same key, method, path, query and body again answers it again,\nwith `Idempotent-Replayed: true`, instead of acting twice. The fingerprint is the method,\npath, query string and body, so the same key with another method, path, query or body\nanswers `idempotency_key_reused` (422); while the first request still runs,\n`idempotency_key_in_progress` (409). A 5xx or 429 answer is not kept, so retrying with the\nsame key runs the request again. Other methods ignore the header.\n\nEvery tenant runs under a plan (`GET /v1/usage` shows it). Requests over its API rate,\ncounted per minute for the tenant and for each credential, answer `rate_limited` with a\n`Retry-After` header. Every call counted against the rate answers `RateLimit-Limit`,\n`RateLimit-Remaining` and `RateLimit-Reset` (seconds until the window ends), for whichever\nof the two windows has fewer requests left. Creations beyond its limits answer\n`plan_limit_accounts`, `plan_limit_sends`, `plan_limit_validations`, `plan_limit_webhooks`\nor `plan_limit_storage`; a connect flow stopped by the account limit returns to your\n`redirectUri` with `status=error&error=plan_limit_accounts`.\n\nA plan also names its modules (`plan.limits.modules`): calendar, contacts, tracking, ai,\nmeetings and sharedMailboxes; mail is not a module. Routes of a module the plan lacks\n(Calendar, Contacts, meeting apps and connections, shared mailboxes, AI drafts, and\ntracking asked for on a send) answer `plan_module_unavailable`. Without\nthe module its settings have no effect: no calendar or contacts sync, no calendar or\ncontacts scopes on connect, no tracking defaults on sends, no reply classification.\nShared-mailbox accounts added before the plan lost sharedMailboxes keep syncing and\nsending like any other account; only adding new ones (and asking for the shared mailbox\nscope on connect) is refused.\n\nBeyond the plan, each API process limits how much of it one caller takes. Past 16\nrequests in flight for one credential (a download counts until its body is sent), a\nrequest answers `too_many_requests`; when the process is overloaded, `overloaded`. Both\ncarry `Retry-After`, and neither did anything, so retrying after it is safe. A client\naddress that fails authentication too often in a minute has its bearer tokens refused\nwith `rate_limited` until the minute ends, except API keys that authenticated recently.\nDownloads are sent chunked, without `Content-Length`: sizes are in the message's `size`,\neach attachment's `size` and an export's `bytes`.\n\nOAuth redirect URI: register\n`https://api.workwae.com/connect/callback/google` and `https://api.workwae.com/connect/callback/microsoft`\nwith your own OAuth apps (one Microsoft app per cloud). The same callbacks serve the\nplatform apps. After sign-in the user returns to your `redirectUri` (which must be listed\nin `settings.redirectUris`) with `status=success&account_id=...&state=...` or\n`status=error&error=<code>&state=...`. A hosted session without one ends on Workwae's own\nconfirmation page; read its outcome with `GET /v1/connect-sessions/{sessionId}`."},"servers":[{"url":"https://api.workwae.com"}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"API key or account token"}},"schemas":{"EventId":{"type":"string","pattern":"^[0-9]{1,19}$"},"Address":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"address":{"type":"string"}},"required":["name","address"]},"AddressInput":{"type":"object","properties":{"name":{"type":"string","maxLength":256},"address":{"type":"string","maxLength":320,"format":"email"}},"required":["address"]},"BodyStorage":{"enum":["none","cache","full"],"type":"string"},"EffectiveSettings":{"type":"object","properties":{"bodyStorage":{"$ref":"#/components/schemas/BodyStorage"},"syncWindowDays":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0},{"type":"null"}]},"mailEnabled":{"type":"boolean"},"calendarEnabled":{"type":"boolean"},"contactsEnabled":{"type":"boolean"},"undoSendSeconds":{"type":"integer","minimum":0,"maximum":60},"trackOpens":{"type":"boolean"},"trackClicks":{"type":"boolean"},"trackingHoneypot":{"type":"boolean"}},"required":["bodyStorage","syncWindowDays","mailEnabled","calendarEnabled","contactsEnabled","undoSendSeconds","trackOpens","trackClicks","trackingHoneypot"]},"SettingsOverride":{"type":"object","properties":{"bodyStorage":{"$ref":"#/components/schemas/BodyStorage"},"syncWindowDays":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0},{"type":"null"}]},"mailEnabled":{"type":"boolean"},"calendarEnabled":{"type":"boolean"},"contactsEnabled":{"type":"boolean"},"undoSendSeconds":{"type":"integer","minimum":0,"maximum":60},"trackOpens":{"type":"boolean"},"trackClicks":{"type":"boolean"},"trackingHoneypot":{"type":"boolean"}}},"OptOutHandling":{"enum":["off","review","suppress"],"type":"string"},"McpSendMode":{"enum":["allow","confirm","drafts_only"],"type":"string"},"McpSendPolicy":{"type":"object","properties":{"mode":{"$ref":"#/components/schemas/McpSendMode"},"allowedRecipientDomains":{"anyOf":[{"type":"array","minItems":1,"maxItems":100,"items":{"type":"string","pattern":"^(?=.{1,253}$)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z0-9-]{2,63}$"}},{"type":"null"}]},"dailySendLimit":{"anyOf":[{"type":"integer","minimum":1,"maximum":10000},{"type":"null"}]},"externalRecipientConfirmation":{"type":"boolean"}},"required":["mode","allowedRecipientDomains","dailySendLimit","externalRecipientConfirmation"]},"McpSendPolicyPatch":{"type":"object","properties":{"mode":{"$ref":"#/components/schemas/McpSendMode"},"allowedRecipientDomains":{"anyOf":[{"type":"array","minItems":1,"maxItems":100,"items":{"type":"string","pattern":"^(?=.{1,253}$)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z0-9-]{2,63}$"}},{"type":"null"}]},"dailySendLimit":{"anyOf":[{"type":"integer","minimum":1,"maximum":10000},{"type":"null"}]},"externalRecipientConfirmation":{"type":"boolean"}}},"TenantSettings":{"type":"object","properties":{"bodyStorage":{"$ref":"#/components/schemas/BodyStorage"},"syncWindowDays":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0},{"type":"null"}]},"mailEnabled":{"type":"boolean"},"calendarEnabled":{"type":"boolean"},"contactsEnabled":{"type":"boolean"},"undoSendSeconds":{"type":"integer","minimum":0,"maximum":60},"trackOpens":{"type":"boolean"},"trackClicks":{"type":"boolean"},"trackingHoneypot":{"type":"boolean"},"optOutHandling":{"$ref":"#/components/schemas/OptOutHandling"},"eventRetentionDays":{"type":"integer","minimum":7,"maximum":30},"redirectUris":{"type":"array","maxItems":50,"items":{"type":"string","format":"uri"}},"aiReplyClassification":{"type":"boolean"},"mcpSendPolicy":{"$ref":"#/components/schemas/McpSendPolicy"}},"required":["bodyStorage","syncWindowDays","mailEnabled","calendarEnabled","contactsEnabled","undoSendSeconds","trackOpens","trackClicks","trackingHoneypot","optOutHandling","eventRetentionDays","redirectUris","aiReplyClassification","mcpSendPolicy"]},"UpdateTenantSettings":{"type":"object","properties":{"bodyStorage":{"$ref":"#/components/schemas/BodyStorage"},"syncWindowDays":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0},{"type":"null"}]},"mailEnabled":{"type":"boolean"},"calendarEnabled":{"type":"boolean"},"contactsEnabled":{"type":"boolean"},"undoSendSeconds":{"type":"integer","minimum":0,"maximum":60},"trackOpens":{"type":"boolean"},"trackClicks":{"type":"boolean"},"trackingHoneypot":{"type":"boolean"},"optOutHandling":{"$ref":"#/components/schemas/OptOutHandling"},"eventRetentionDays":{"type":"integer","minimum":7,"maximum":30},"redirectUris":{"type":"array","maxItems":50,"items":{"type":"string","format":"uri"}},"aiReplyClassification":{"type":"boolean"},"mcpSendPolicy":{"$ref":"#/components/schemas/McpSendPolicyPatch"}}},"OAuthProvider":{"enum":["google","microsoft"],"type":"string"},"MicrosoftCloud":{"enum":["global","gcc-high","dod","china"],"type":"string"},"AccountProvider":{"enum":["gmail","graph","imap"],"type":"string"},"AccountStatus":{"enum":["active","paused","reauth_required","disabled"],"type":"string"},"SettableAccountStatus":{"enum":["active","paused"],"type":"string"},"RuntimeState":{"enum":["pending","connecting","connected","error","stopped"],"type":"string"},"AccountRuntime":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/RuntimeState"},"detail":{"anyOf":[{"type":"string"},{"type":"null"}]},"ownerInstanceId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"updatedAt":{"type":"string","format":"date-time","x-native-type":"date"}},"required":["state","detail","ownerInstanceId","updatedAt"]},"MailSecurity":{"enum":["tls","starttls","none"],"type":"string"},"MailServer":{"type":"object","properties":{"host":{"type":"string"},"port":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"security":{"$ref":"#/components/schemas/MailSecurity"},"user":{"type":"string"}},"required":["host","port","security","user"]},"DavAuth":{"enum":["imap_password","dav_password"],"type":"string"},"DavSettings":{"type":"object","properties":{"calendarUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"contactsUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"user":{"type":"string"},"auth":{"$ref":"#/components/schemas/DavAuth"}},"required":["calendarUrl","contactsUrl","user","auth"]},"ImapAuth":{"enum":["password","google","microsoft"],"type":"string"},"ImapSettings":{"type":"object","properties":{"imap":{"$ref":"#/components/schemas/MailServer"},"smtp":{"anyOf":[{"$ref":"#/components/schemas/MailServer"},{"type":"null"}]},"auth":{"$ref":"#/components/schemas/ImapAuth"},"appendSent":{"type":"boolean"},"dav":{"anyOf":[{"$ref":"#/components/schemas/DavSettings"},{"type":"null"}]}},"required":["imap","smtp","auth","appendSent","dav"]},"AccountAuthMethod":{"enum":["oauth","password","google_delegation","microsoft_app","shared_mailbox","google_group"],"type":"string"},"AccountAuth":{"type":"object","properties":{"method":{"$ref":"#/components/schemas/AccountAuthMethod"},"orgConnectionId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"delegateAccountId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"relayEmail":{"anyOf":[{"type":"string","maxLength":320,"format":"email"},{"type":"null"}]}},"required":["method","orgConnectionId","delegateAccountId","relayEmail"]},"Account":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"externalRef":{"anyOf":[{"type":"string"},{"type":"null"}]},"provider":{"$ref":"#/components/schemas/AccountProvider"},"email":{"type":"string"},"displayName":{"anyOf":[{"type":"string"},{"type":"null"}]},"oauthAppId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"cloud":{"anyOf":[{"$ref":"#/components/schemas/MicrosoftCloud"},{"type":"null"}]},"status":{"$ref":"#/components/schemas/AccountStatus"},"statusReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"$ref":"#/components/schemas/EffectiveSettings"},"settingsOverride":{"$ref":"#/components/schemas/SettingsOverride"},"runtime":{"anyOf":[{"$ref":"#/components/schemas/AccountRuntime"},{"type":"null"}]},"imap":{"anyOf":[{"$ref":"#/components/schemas/ImapSettings"},{"type":"null"}]},"auth":{"$ref":"#/components/schemas/AccountAuth"},"initializedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"calendarInitializedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"contactsInitializedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"updatedAt":{"type":"string","format":"date-time","x-native-type":"date"}},"required":["id","externalRef","provider","email","displayName","oauthAppId","cloud","status","statusReason","settings","settingsOverride","runtime","imap","auth","initializedAt","calendarInitializedAt","contactsInitializedAt","createdAt","updatedAt"]},"SyncKind":{"enum":["mail","calendar","contacts"],"type":"string"},"AccountSyncQueued":{"type":"object","properties":{"kinds":{"type":"array","items":{"$ref":"#/components/schemas/SyncKind"}}},"required":["kinds"]},"AccountPage":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Account"}},"nextCursor":{"anyOf":[{"type":"string","minLength":1,"maxLength":512},{"type":"null"}]}},"required":["items","nextCursor"]},"CreateAccount":{"type":"object","properties":{"provider":{"$ref":"#/components/schemas/OAuthProvider"},"microsoftCloud":{"$ref":"#/components/schemas/MicrosoftCloud","default":"global"},"refreshToken":{"type":"string","minLength":1},"oauthAppId":{"type":"string","format":"uuid"},"externalRef":{"type":"string","maxLength":255},"settings":{"$ref":"#/components/schemas/SettingsOverride"},"sharedMailboxesEnabled":{"type":"boolean"}},"required":["provider","refreshToken"]},"AccountToken":{"type":"object","properties":{"token":{"type":"string"},"expiresAt":{"type":"string","format":"date-time","x-native-type":"date"}},"required":["token","expiresAt"]},"MailServerInput":{"type":"object","properties":{"host":{"type":"string","minLength":1,"maxLength":253},"port":{"type":"integer","minimum":1,"maximum":65535},"security":{"$ref":"#/components/schemas/MailSecurity"},"user":{"type":"string","minLength":1,"maxLength":320}},"required":["host","port","security"]},"DavInput":{"type":"object","properties":{"calendarUrl":{"anyOf":[{"type":"string","maxLength":2048,"format":"uri"},{"type":"null"}]},"contactsUrl":{"anyOf":[{"type":"string","maxLength":2048,"format":"uri"},{"type":"null"}]},"user":{"type":"string","minLength":1,"maxLength":320},"password":{"anyOf":[{"type":"string","minLength":1,"maxLength":1024},{"type":"null"}]}}},"CreateImapAccount":{"type":"object","properties":{"email":{"type":"string","maxLength":320,"format":"email"},"displayName":{"type":"string","maxLength":255},"password":{"type":"string","minLength":1,"maxLength":1024},"smtpPassword":{"type":"string","minLength":1,"maxLength":1024},"imap":{"$ref":"#/components/schemas/MailServerInput"},"smtp":{"anyOf":[{"$ref":"#/components/schemas/MailServerInput"},{"type":"null"}]},"appendSent":{"type":"boolean"},"dav":{"$ref":"#/components/schemas/DavInput"},"externalRef":{"type":"string","maxLength":255},"settings":{"$ref":"#/components/schemas/SettingsOverride"}},"required":["email","password"]},"DavDiscoverySource":{"enum":["provider","well-known","srv"],"type":"string"},"DiscoveredDav":{"type":"object","properties":{"source":{"$ref":"#/components/schemas/DavDiscoverySource"},"calendarUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"contactsUrl":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["source","calendarUrl","contactsUrl"]},"AutoconfigSource":{"enum":["provider","autoconfig","ispdb","srv","mx"],"type":"string"},"DiscoveredSettings":{"type":"object","properties":{"source":{"$ref":"#/components/schemas/AutoconfigSource"},"imap":{"$ref":"#/components/schemas/MailServer"},"smtp":{"anyOf":[{"$ref":"#/components/schemas/MailServer"},{"type":"null"}]},"oauth":{"anyOf":[{"$ref":"#/components/schemas/OAuthProvider"},{"type":"null"}]},"dav":{"anyOf":[{"$ref":"#/components/schemas/DiscoveredDav"},{"type":"null"}]}},"required":["source","imap","smtp","oauth","dav"]},"TemplateSource":{"enum":["handlebars","react-email"],"type":"string"},"TemplateFormat":{"enum":["html","markdown"],"type":"string"},"TemplateField":{"enum":["subject","html","text","previewText"],"type":"string"},"TemplateSummary":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"accountId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"source":{"$ref":"#/components/schemas/TemplateSource"},"externalRef":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"updatedAt":{"type":"string","format":"date-time","x-native-type":"date"}},"required":["id","accountId","name","description","source","externalRef","createdAt","updatedAt"]},"Template":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"accountId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"source":{"$ref":"#/components/schemas/TemplateSource"},"externalRef":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"updatedAt":{"type":"string","format":"date-time","x-native-type":"date"},"subject":{"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}]},"html":{"anyOf":[{"type":"string","maxLength":1000000},{"type":"null"}]},"text":{"anyOf":[{"type":"string","maxLength":1000000},{"type":"null"}]},"previewText":{"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}]},"format":{"$ref":"#/components/schemas/TemplateFormat"}},"required":["id","accountId","name","description","source","externalRef","createdAt","updatedAt","subject","html","text","previewText","format"]},"TemplateSummaryPage":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/TemplateSummary"}},"nextCursor":{"anyOf":[{"type":"string","minLength":1,"maxLength":512},{"type":"null"}]}},"required":["items","nextCursor"]},"RenderParams":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}},"RenderedTemplate":{"type":"object","properties":{"subject":{"anyOf":[{"type":"string"},{"type":"null"}]},"html":{"anyOf":[{"type":"string"},{"type":"null"}]},"text":{"anyOf":[{"type":"string"},{"type":"null"}]},"previewText":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["subject","html","text","previewText"]},"CreateTemplate":{"type":"object","properties":{"accountId":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1,"maxLength":255},"description":{"type":"string","maxLength":1000},"subject":{"type":"string","maxLength":2000},"html":{"type":"string","maxLength":1000000},"text":{"type":"string","maxLength":1000000},"previewText":{"type":"string","maxLength":2000},"format":{"$ref":"#/components/schemas/TemplateFormat","default":"html"},"source":{"$ref":"#/components/schemas/TemplateSource","default":"handlebars"},"externalRef":{"type":"string","maxLength":255}},"required":["name"]},"RenderTemplateRequest":{"type":"object","properties":{"templateId":{"type":"string","format":"uuid"},"accountId":{"type":"string","format":"uuid"},"subject":{"type":"string","maxLength":2000},"html":{"type":"string","maxLength":1000000},"text":{"type":"string","maxLength":1000000},"previewText":{"type":"string","maxLength":2000},"format":{"$ref":"#/components/schemas/TemplateFormat"},"params":{"$ref":"#/components/schemas/RenderParams","default":{}}}},"InputIssue":{"type":"object","properties":{"path":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"}]}},"message":{"type":"string"}},"required":["path","message"]},"InvalidInputData":{"type":"object","properties":{"issues":{"type":"array","items":{"$ref":"#/components/schemas/InputIssue"}}},"required":["issues"]},"UnknownIdsData":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["ids"]},"SyncKindsData":{"type":"object","properties":{"kinds":{"type":"array","items":{"$ref":"#/components/schemas/SyncKind"}}},"required":["kinds"]},"TemplateFieldData":{"type":"object","properties":{"field":{"$ref":"#/components/schemas/TemplateField"}},"required":["field"]},"MailboxRole":{"enum":["inbox","sent","drafts","trash","junk","archive","all","important","custom"],"type":"string"},"MailboxKind":{"enum":["folder","label"],"type":"string"},"Mailbox":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"path":{"type":"string"},"parentId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"role":{"$ref":"#/components/schemas/MailboxRole"},"kind":{"$ref":"#/components/schemas/MailboxKind"},"totalCount":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"unreadCount":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["id","name","path","parentId","role","kind","totalCount","unreadCount"]},"MailboxList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Mailbox"}}},"required":["items"]},"MailboxChangedField":{"enum":["name","path","parentId","role","kind"],"type":"string"},"MessageDirection":{"enum":["inbound","outbound"],"type":"string"},"MessagePriority":{"enum":["high","normal","low"],"type":"string"},"MessageSummary":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"threadId":{"anyOf":[{"type":"string","minLength":1,"maxLength":1024},{"type":"null"}]},"internetMessageId":{"anyOf":[{"type":"string"},{"type":"null"}]},"mailboxIds":{"type":"array","items":{"type":"string","format":"uuid"}},"subject":{"anyOf":[{"type":"string"},{"type":"null"}]},"from":{"anyOf":[{"$ref":"#/components/schemas/Address"},{"type":"null"}]},"to":{"type":"array","items":{"$ref":"#/components/schemas/Address"}},"cc":{"type":"array","items":{"$ref":"#/components/schemas/Address"}},"snippet":{"anyOf":[{"type":"string"},{"type":"null"}]},"receivedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"sentAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"isRead":{"type":"boolean"},"isFlagged":{"type":"boolean"},"isDraft":{"type":"boolean"},"hasAttachments":{"type":"boolean"},"categories":{"type":"array","items":{"type":"string"}},"direction":{"$ref":"#/components/schemas/MessageDirection"},"outboxId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"reference":{"anyOf":[{"type":"string"},{"type":"null"}]},"importance":{"anyOf":[{"$ref":"#/components/schemas/MessagePriority"},{"type":"null"}]}},"required":["id","threadId","internetMessageId","mailboxIds","subject","from","to","cc","snippet","receivedAt","sentAt","isRead","isFlagged","isDraft","hasAttachments","categories","direction","outboxId","reference","importance"]},"MessageChangedField":{"enum":["threadId","internetMessageId","subject","from","to","cc","bcc","replyTo","snippet","receivedAt","sentAt","isRead","isFlagged","isDraft","hasAttachments","categories","mailboxIds","direction","outboxId","importance"],"type":"string"},"MessageSummaryPage":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/MessageSummary"}},"nextCursor":{"anyOf":[{"type":"string","minLength":1,"maxLength":512},{"type":"null"}]}},"required":["items","nextCursor"]},"Attachment":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":1024},"filename":{"anyOf":[{"type":"string"},{"type":"null"}]},"contentType":{"type":"string"},"size":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"isInline":{"type":"boolean"},"contentId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","filename","contentType","size","isInline","contentId"]},"ReplyKind":{"enum":["opt_out","auto_reply","bounce","human_reply"],"type":"string"},"AutoReplyCategory":{"enum":["out_of_office","left_company","address_changed","ticket_acknowledgment","challenge_response","other"],"type":"string"},"MessageClassification":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ReplyKind"},"probabilities":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"number"}},"optOutProbability":{"type":"number"},"autoReplyCategory":{"anyOf":[{"$ref":"#/components/schemas/AutoReplyCategory"},{"type":"null"}]},"returnDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"alternateContacts":{"type":"array","items":{"type":"string"}},"outboxId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"model":{"type":"string"},"classifiedAt":{"type":"string","format":"date-time","x-native-type":"date"}},"required":["kind","probabilities","optOutProbability","autoReplyCategory","returnDate","alternateContacts","outboxId","model","classifiedAt"]},"MessageBody":{"type":"object","properties":{"text":{"anyOf":[{"type":"string"},{"type":"null"}]},"html":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["text","html"]},"Message":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"threadId":{"anyOf":[{"type":"string","minLength":1,"maxLength":1024},{"type":"null"}]},"internetMessageId":{"anyOf":[{"type":"string"},{"type":"null"}]},"mailboxIds":{"type":"array","items":{"type":"string","format":"uuid"}},"subject":{"anyOf":[{"type":"string"},{"type":"null"}]},"from":{"anyOf":[{"$ref":"#/components/schemas/Address"},{"type":"null"}]},"to":{"type":"array","items":{"$ref":"#/components/schemas/Address"}},"cc":{"type":"array","items":{"$ref":"#/components/schemas/Address"}},"snippet":{"anyOf":[{"type":"string"},{"type":"null"}]},"receivedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"sentAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"isRead":{"type":"boolean"},"isFlagged":{"type":"boolean"},"isDraft":{"type":"boolean"},"hasAttachments":{"type":"boolean"},"categories":{"type":"array","items":{"type":"string"}},"direction":{"$ref":"#/components/schemas/MessageDirection"},"outboxId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"reference":{"anyOf":[{"type":"string"},{"type":"null"}]},"importance":{"anyOf":[{"$ref":"#/components/schemas/MessagePriority"},{"type":"null"}]},"bcc":{"type":"array","items":{"$ref":"#/components/schemas/Address"}},"replyTo":{"type":"array","items":{"$ref":"#/components/schemas/Address"}},"body":{"$ref":"#/components/schemas/MessageBody"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/Attachment"}},"classification":{"anyOf":[{"$ref":"#/components/schemas/MessageClassification"},{"type":"null"}]}},"required":["id","threadId","internetMessageId","mailboxIds","subject","from","to","cc","snippet","receivedAt","sentAt","isRead","isFlagged","isDraft","hasAttachments","categories","direction","outboxId","reference","importance","bcc","replyTo","body","attachments","classification"]},"SearchSource":{"enum":["auto","index","provider"],"type":"string"},"SearchResultSource":{"enum":["index","provider"],"type":"string"},"SearchHit":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"threadId":{"anyOf":[{"type":"string","minLength":1,"maxLength":1024},{"type":"null"}]},"internetMessageId":{"anyOf":[{"type":"string"},{"type":"null"}]},"mailboxIds":{"type":"array","items":{"type":"string","format":"uuid"}},"subject":{"anyOf":[{"type":"string"},{"type":"null"}]},"from":{"anyOf":[{"$ref":"#/components/schemas/Address"},{"type":"null"}]},"to":{"type":"array","items":{"$ref":"#/components/schemas/Address"}},"cc":{"type":"array","items":{"$ref":"#/components/schemas/Address"}},"snippet":{"anyOf":[{"type":"string"},{"type":"null"}]},"receivedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"sentAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"isRead":{"type":"boolean"},"isFlagged":{"type":"boolean"},"isDraft":{"type":"boolean"},"hasAttachments":{"type":"boolean"},"categories":{"type":"array","items":{"type":"string"}},"direction":{"$ref":"#/components/schemas/MessageDirection"},"outboxId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"reference":{"anyOf":[{"type":"string"},{"type":"null"}]},"importance":{"anyOf":[{"$ref":"#/components/schemas/MessagePriority"},{"type":"null"}]}},"required":["id","threadId","internetMessageId","mailboxIds","subject","from","to","cc","snippet","receivedAt","sentAt","isRead","isFlagged","isDraft","hasAttachments","categories","direction","outboxId","reference","importance"]},"SearchPage":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SearchHit"}},"nextCursor":{"anyOf":[{"type":"string","minLength":1,"maxLength":512},{"type":"null"}]},"source":{"$ref":"#/components/schemas/SearchResultSource"}},"required":["items","nextCursor","source"]},"PlanModules":{"type":"object","properties":{"calendar":{"type":"boolean"},"contacts":{"type":"boolean"},"tracking":{"type":"boolean"},"ai":{"type":"boolean"},"meetings":{"type":"boolean"},"sharedMailboxes":{"type":"boolean"}},"required":["calendar","contacts","tracking","ai","meetings","sharedMailboxes"]},"PlanIncluded":{"type":"object","properties":{"accounts":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"sendsPerMonth":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"aiCallsPerMonth":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"storageBytes":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]}},"required":["accounts","sendsPerMonth","aiCallsPerMonth","storageBytes"]},"PlanStripePrices":{"type":"object","properties":{"basePrice":{"anyOf":[{"type":"string","maxLength":255,"pattern":"^price_[A-Za-z0-9]+$"},{"type":"null"}]},"accountPrice":{"anyOf":[{"type":"string","maxLength":255,"pattern":"^price_[A-Za-z0-9]+$"},{"type":"null"}]},"sendsPrice":{"anyOf":[{"type":"string","maxLength":255,"pattern":"^price_[A-Za-z0-9]+$"},{"type":"null"}]},"aiCallsPrice":{"anyOf":[{"type":"string","maxLength":255,"pattern":"^price_[A-Za-z0-9]+$"},{"type":"null"}]},"storagePrice":{"anyOf":[{"type":"string","maxLength":255,"pattern":"^price_[A-Za-z0-9]+$"},{"type":"null"}]}},"required":["basePrice","accountPrice","sendsPrice","aiCallsPrice","storagePrice"]},"PlanPricing":{"type":"object","properties":{"currency":{"type":"string","pattern":"^[a-z]{3}$"},"baseMonthly":{"type":"integer","minimum":0,"maximum":9007199254740991},"perAccountMonthly":{"type":"integer","minimum":0,"maximum":9007199254740991},"sendsPer1k":{"type":"integer","minimum":0,"maximum":9007199254740991},"aiCallsPer1k":{"type":"inte

# --- truncated at 32 KB (1727 KB total) ---
# Full source: https://artifacts.apis.io/workwae-com/openapi/_original/workwae-com-v1-openapi.json