How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
workwae-com

Workwae API V1 API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

Workwae API V1 API is one of 2 APIs that workwae-com publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 6 JSON Schema definitions.

The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

This API exposes 141 operations across 95 paths, organized into 24 resource areas, and defines 346 schemas. It is described by OpenAPI 3.1.1, at version 1.0.0.

Requests are made against a single base URL, https://api.workwae.com.

141 operations 95 paths 346 schemas 22 DELETE53 GET18 PATCH47 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.1
API Version
1.0.0
Base URL
https://api.workwae.com
Authentication
HTTP Bearer
Resource Areas
24

Authentication & Security 1

Workwae API V1 API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearer). By default, every request must be authenticated.

  • bearer — API key or account token

Paths & Operations 141

Across 95 paths, the API surfaces 141 operations — 22 DELETE, 53 GET, 18 PATCH, 47 POST, 1 PUT. They span 24 resource areas, including Accounts, MCP keys, Mail, Templates, Suppressions, Identities, Calendar, Scheduling, and 16 more. Each is listed below with its method, path, parameters, and response codes.

Accounts 10
GET
/v1/accounts
List accounts
accounts.list 7 params → 200400401403409413422429
POST
/v1/accounts
Connect an account from an existing refresh token
accounts.create 1 param body → 201400401402403409413422
GET
/v1/accounts/{accountId}
Get an account
accounts.get 1 param → 200400401403404409413422
PATCH
/v1/accounts/{accountId}
Update an account
accounts.update 1 param body → 200400401403404409413422
DELETE
/v1/accounts/{accountId}
Delete an account
accounts.delete 2 params → 204400401403404409413422
POST
/v1/accounts/{accountId}/sync
Sync an account now
accounts.sync 2 params body → 202400401403404409413422
POST
/v1/accounts/{accountId}/tokens
Mint an account-scoped token
accounts.mintToken 2 params body → 200400401403404409413422
POST
/v1/imap-accounts
Connect an IMAP/SMTP account with a password
imapAccounts.create 1 param body → 201400401402403409413422
PATCH
/v1/accounts/{accountId}/imap-settings
Change an IMAP account's servers or password
imapSettings.update 1 param body → 200400401403404409413422
GET
/v1/autoconfig
Find IMAP, SMTP and DAV settings for an address
autoconfig.lookup 1 param → 200400401403409413422429
MCP keys 3
POST
/v1/accounts/{accountId}/mcp-keys
Mint an MCP key for an account's user
mcpKeys.create 2 params body → 201400401403404409413422
GET
/v1/accounts/{accountId}/mcp-keys
List an account's MCP keys
mcpKeys.list 1 param → 200400401403404409413422
DELETE
/v1/accounts/{accountId}/mcp-keys/{keyId}
Revoke an MCP key
mcpKeys.delete 2 params → 204400401403404409413422
Mail 26
GET
/v1/accounts/{accountId}/mailboxes
List mailboxes (folders or labels)
mailboxes.list 1 param → 200400401403404409413422
POST
/v1/accounts/{accountId}/mailboxes
Create a mailbox (folder or label)
mailboxes.create 2 params body → 201400401403404409413422
PATCH
/v1/accounts/{accountId}/mailboxes/{mailboxId}
Rename or move a mailbox
mailboxes.update 2 params body → 200400401403404409413422
DELETE
/v1/accounts/{accountId}/mailboxes/{mailboxId}
Delete a mailbox
mailboxes.delete 2 params → 204400401403404409413422
GET
/v1/accounts/{accountId}/messages
List messages, newest first
messages.list 12 params → 200400401403404409413422
GET
/v1/accounts/{accountId}/messages/{messageId}
Get a message with its body
messages.get 2 params → 200400401403404409413422
PATCH
/v1/accounts/{accountId}/messages/{messageId}
Change flags, move, or change labels
messages.update 2 params body → 200400401403404409413422
DELETE
/v1/accounts/{accountId}/messages/{messageId}
Delete a message
messages.delete 3 params → 204400401403404409413422
GET
/v1/accounts/{accountId}/messages/{messageId}/raw
Download the message as RFC 5322 (message/rfc822)
messages.raw 2 params → 200400401403404409413422
GET
/v1/accounts/{accountId}/messages/{messageId}/attachments/{attachmentId}
Download an attachment
messages.attachment 3 params → 200400401403404409413422
GET
/v1/accounts/{accountId}/search/messages
Search messages
search.messages 13 params → 200400401403404409413422
GET
/v1/accounts/{accountId}/threads
List threads, latest activity first
threads.list 4 params → 200400401403404409413422
GET
/v1/accounts/{accountId}/threads/{threadId}
Get a thread with its messages, oldest first
threads.get 2 params → 200400401403404409413422
PATCH
/v1/accounts/{accountId}/threads/{threadId}
Mark a thread read or unread, or move it
threads.update 2 params body → 200400401403404409413422
DELETE
/v1/accounts/{accountId}/threads/{threadId}
Move a thread to Trash
threads.delete 2 params → 204400401403404409413422
POST
/v1/accounts/{accountId}/drafts
Create a draft
drafts.create 2 params body → 201400401403404409413422
PUT
/v1/accounts/{accountId}/drafts/{messageId}
Replace a draft's content
drafts.update 2 params body → 200400401403404409413422
DELETE
/v1/accounts/{accountId}/drafts/{messageId}
Delete a draft
drafts.delete 2 params → 204400401403404409413422
POST
/v1/accounts/{accountId}/drafts/{messageId}/send
Send a draft
drafts.send 3 params body → 201400401402403404409413
POST
/v1/accounts/{accountId}/outbox
Send a message
outbox.create 2 params body → 201400401402403404409413
GET
/v1/accounts/{accountId}/outbox
List queued and recent sends, newest first
outbox.list 4 params → 200400401403404409413422
GET
/v1/accounts/{accountId}/outbox/{outboxId}
Get a send
outbox.get 2 params → 200400401403404409413422
DELETE
/v1/accounts/{accountId}/outbox/{outboxId}
Cancel a queued send
outbox.cancel 2 params → 204400401403404409413422
PATCH
/v1/accounts/{accountId}/outbox/{outboxId}
Reschedule a queued send
outbox.reschedule 2 params body → 200400401403404409413422
GET
/v1/accounts/{accountId}/outbox/{outboxId}/tracking
List a send's opens and clicks
outbox.tracking 4 params → 200400401403404409413422
POST
/v1/accounts/{accountId}/mail-merges
Send one message per recipient (mail merge)
mailMerges.create 2 params body → 200400401402403404409413
Templates 6
GET
/v1/templates
List templates
templates.list 6 params → 200400401403409413422429
POST
/v1/templates
Create a template
templates.create 1 param body → 201400401403409413422429
GET
/v1/templates/{templateId}
Get a template
templates.get 1 param → 200400401403404409413422
PATCH
/v1/templates/{templateId}
Update a template
templates.update 1 param body → 200400401403404409413422
DELETE
/v1/templates/{templateId}
Delete a template
templates.delete 1 param → 204400401403404409413422
POST
/v1/template-renders
Render a template without sending
templateRenders.create 1 param body → 200400401403409413422429
Suppressions 10
GET
/v1/suppressions
List suppression lists
suppressions.list → 200400401403409413422429
POST
/v1/suppressions
Create a suppression list
suppressions.create 1 param body → 201400401403409413422429
PATCH
/v1/suppressions/{listId}
Update a suppression list
suppressions.update 1 param body → 200400401403404409413422
DELETE
/v1/suppressions/{listId}
Delete a suppression list
suppressions.delete 2 params → 204400401403404409413422
GET
/v1/suppressions/{listId}/entries
List suppressed addresses
suppressions.entries.list 5 params → 200400401403409413422429
POST
/v1/suppressions/{listId}/entries
Suppress addresses
suppressions.entries.add 2 params body → 200400401403409413422429
DELETE
/v1/suppressions/{listId}/entries/{address}
Release an address
suppressions.entries.remove 2 params → 204400401403404409413422
GET
/v1/suppression-reviews
List opt-outs to review
suppressionReviews.list 3 params → 200400401403409413422429
POST
/v1/suppression-reviews/{reviewId}/approve
Approve an opt-out
suppressionReviews.approve 2 params → 200400401403404409413422
POST
/v1/suppression-reviews/{reviewId}/dismiss
Dismiss an opt-out
suppressionReviews.dismiss 2 params → 204400401403404409413422
Identities 6
GET
/v1/accounts/{accountId}/identities
List the addresses the account may send as
identities.list 2 params → 200400401403404409413422
POST
/v1/accounts/{accountId}/identities
Add a custom identity
identities.create 2 params body → 201400401403404409413422
PATCH
/v1/accounts/{accountId}/identities/{identityId}
Change an identity's signature or name
identities.update 2 params body → 200400401403404409413422
DELETE
/v1/accounts/{accountId}/identities/{identityId}
Remove a custom identity
identities.delete 2 params → 204400401403404409413422
GET
/v1/accounts/{accountId}/mail-settings
Get the account's mail settings
mailSettings.get 1 param → 200400401403404409413422
PATCH
/v1/accounts/{accountId}/mail-settings
Update the account's mail settings
mailSettings.update 1 param body → 200400401403404409413422
Calendar 12
GET
/v1/accounts/{accountId}/calendars
List calendars
calendars.list 1 param → 200400401403404409413422
POST
/v1/accounts/{accountId}/calendars
Create a calendar
calendars.create 2 params body → 201400401403404409413422
PATCH
/v1/accounts/{accountId}/calendars/{calendarId}
Rename a calendar or change its color
calendars.update 2 params body → 200400401403404409413422
DELETE
/v1/accounts/{accountId}/calendars/{calendarId}
Delete a calendar
calendars.delete 2 params → 204400401403404409413422
GET
/v1/accounts/{accountId}/calendar-events
List events in a time range, by start
calendarEvents.list 6 params → 200400401403404409413422
POST
/v1/accounts/{accountId}/calendar-events
Create an event or a recurring series
calendarEvents.create 2 params body → 201400401403404409413422
GET
/v1/accounts/{accountId}/calendar-events/{eventId}
Get an event with its body
calendarEvents.get 2 params → 200400401403404409413422
PATCH
/v1/accounts/{accountId}/calendar-events/{eventId}
Change an event, one occurrence, or a whole series
calendarEvents.update 2 params body → 200400401403404409413422
DELETE
/v1/accounts/{accountId}/calendar-events/{eventId}
Delete an event, one occurrence, or a whole series
calendarEvents.delete 4 params → 204400401403404409413422
POST
/v1/accounts/{accountId}/calendar-events/{eventId}/respond
Accept, tentatively accept or decline an invitation
calendarEvents.respond 3 params body → 200400401403404409413422
POST
/v1/accounts/{accountId}/availability/find
Find busy times and common free slots
availability.find 2 params body → 200400401403404409413422
POST
/v1/availability/find
Find free slots across several accounts
availability.findForAccounts 1 param body → 200400401403409413422429
Scheduling 8
GET
/v1/scheduling-links
List scheduling links
schedulingLinks.list 2 params → 200400401403409413422429
POST
/v1/scheduling-links
Create a scheduling link
schedulingLinks.create 1 param body → 201400401403409413422429
GET
/v1/scheduling-links/{linkId}
Get a scheduling link
schedulingLinks.get 1 param → 200400401403404409413422
PATCH
/v1/scheduling-links/{linkId}
Update a scheduling link
schedulingLinks.update 1 param body → 200400401403404409413422
DELETE
/v1/scheduling-links/{linkId}
Delete a scheduling link
schedulingLinks.delete 1 param → 204400401403404409413422
GET
/v1/scheduling-links/{linkId}/slots
List bookable slots
schedulingLinks.slots 4 params → 200400401403404409413422
POST
/v1/scheduling-links/{linkId}/bookings
Book a slot
bookings.create 2 params body → 201400401403404409413422
DELETE
/v1/bookings/{bookingId}
Cancel a booking
bookings.cancel 1 param → 200400401403404409413422
Meeting connections 3
GET
/v1/accounts/{accountId}/meeting-connections
List an account's meeting connections
meetingConnections.list 1 param → 200400401403404409413422
DELETE
/v1/accounts/{accountId}/meeting-connections/{service}
Remove a meeting connection
meetingConnections.delete 2 params → 204400401403404409413422
POST
/v1/accounts/{accountId}/meeting-connect-sessions
Create a hosted meeting connect session
meetingConnectSessions.create 2 params body → 200400401403404409413422
Meeting apps 4
GET
/v1/meeting-apps
List meeting apps
meetingApps.list → 200400401403409413422429
POST
/v1/meeting-apps
Register a meeting app
meetingApps.create 1 param body → 201400401403409413422429
POST
/v1/meeting-apps/{appId}/test
Test a meeting server app
meetingApps.test 2 params body → 200400401403404409413422
DELETE
/v1/meeting-apps/{appId}
Delete a meeting app
meetingApps.delete 1 param → 204400401403404409413422
Contacts 7
GET
/v1/accounts/{accountId}/contacts
List or search contacts, by name
contacts.list 5 params → 200400401403404409413422
POST
/v1/accounts/{accountId}/contacts
Create a contact
contacts.create 2 params body → 201400401403404409413422
GET
/v1/accounts/{accountId}/contacts/{contactId}
Get a contact
contacts.get 2 params → 200400401403404409413422
PATCH
/v1/accounts/{accountId}/contacts/{contactId}
Change a contact
contacts.update 2 params body → 200400401403404409413422
DELETE
/v1/accounts/{accountId}/contacts/{contactId}
Delete a contact
contacts.delete 2 params → 204400401403404409413422
GET
/v1/accounts/{accountId}/contacts/{contactId}/photo
Download a contact's photo
contacts.photo 2 params → 200400401403404409413422
GET
/v1/accounts/{accountId}/contact-folders
List contact folders
contactFolders.list 1 param → 200400401403404409413422
Webhooks 11
GET
/v1/webhooks
List webhook endpoints
webhooks.list → 200400401403409413422429
POST
/v1/webhooks
Create a webhook endpoint
webhooks.create 1 param body → 201400401403409413422429
PATCH
/v1/webhooks/{endpointId}
Update a webhook endpoint
webhooks.update 1 param body → 200400401403404409413422
DELETE
/v1/webhooks/{endpointId}
Delete a webhook endpoint
webhooks.delete 1 param → 204400401403404409413422
POST
/v1/webhooks/{endpointId}/rotate-secret
Rotate the signing secret
webhooks.rotateSecret 2 params body → 200400401403404409413422
POST
/v1/webhooks/{endpointId}/test
Send a test event
webhooks.test 2 params body → 202400401403404409413422
GET
/v1/webhooks/{endpointId}/attempts
Read the delivery log
webhooks.attempts 9 params → 200400401403404409413422
POST
/v1/webhooks/{endpointId}/replay
Replay a time range
webhooks.replay 2 params body → 202400401403404409413422
POST
/v1/webhooks/{endpointId}/events/{eventId}/replay
Replay one event
webhooks.replayEvent 3 params → 202400401403404409413422
GET
/v1/webhooks/{endpointId}/failed-deliveries/count
Count failed deliveries
webhooks.countFailed 3 params → 200400401403404409413422
POST
/v1/webhooks/{endpointId}/replay-failed
Replay failed deliveries
webhooks.replayFailed 2 params body → 202400401403404409413422
Changes 1
GET
/v1/changes
Read the change feed
changes.list 3 params → 200400401403409413422429
Settings 2
GET
/v1/settings
Get tenant settings
settings.get → 200400401403409413422429
PATCH
/v1/settings
Update tenant settings
settings.update body → 200400401403409413422429
OAuth apps 4
GET
/v1/oauth-apps
List tenant OAuth apps
oauthApps.list → 200400401403409413422429
POST
/v1/oauth-apps
Register a tenant OAuth app
oauthApps.create 1 param body → 201400401403409413422429
PATCH
/v1/oauth-apps/{appId}
Change a tenant OAuth app: name, client secret, authority or Gmail push
oauthApps.update 1 param body → 200400401403404409413422
DELETE
/v1/oauth-apps/{appId}
Delete a tenant OAuth app
oauthApps.delete 1 param → 204400401403404409413422
Connect 3
POST
/v1/connect-sessions
Create a hosted connect session
connectSessions.create 1 param body → 201400401402403409413422
GET
/v1/connect-sessions/{sessionId}
Read a hosted connect session's outcome
connectSessions.get 1 param → 200400401403404409413422
POST
/v1/oauth-authorizations
Start a headless OAuth connect
oauthAuthorizations.create 1 param body → 200400401402403409413422
Organization connections 10
GET
/v1/org-connections
List organization connections
orgConnections.list → 200400401403409413422429
POST
/v1/org-connections
Register an organization connection
orgConnections.create 1 param body → 201400401403409413422429
GET
/v1/org-connections/{connectionId}
Get an organization connection
orgConnections.get 1 param → 200400401403404409413422
PATCH
/v1/org-connections/{connectionId}
Update an organization connection
orgConnections.update 1 param body → 200400401403404409413422
DELETE
/v1/org-connections/{connectionId}
Delete an organization connection
orgConnections.delete 1 param → 204400401403404409413422
POST
/v1/org-connections/{connectionId}/consent
Start Microsoft admin consent
orgConnections.consent 2 params body → 200400401403404409413422
POST
/v1/org-connections/{connectionId}/test
Test an organization connection
orgConnections.test 2 params body → 200400401403404409413422
GET
/v1/org-connections/{connectionId}/directory-entries
List the directory's mailboxes
orgConnections.directoryEntries 4 params → 200400401403404409413422
POST
/v1/org-connections/{connectionId}/accounts
Add mailboxes as accounts
orgConnections.addAccounts 2 params body → 200400401402403404409413
POST
/v1/org-connections/{connectionId}/groups
Add a Google Group as an account
orgConnections.addGroup 2 params body → 201400401402403404409413
Shared mailboxes 1
POST
/v1/accounts/{accountId}/shared-mailboxes
Open a shared mailbox with an account's grant
sharedMailboxes.create 2 params body → 201400401402403404409413
Hosted pages 4
GET
/v1/hosted/connect-sessions/{token}
Read a hosted connect session
hostedConnectSessions.get 1 param → 200400401403404409413422
POST
/v1/hosted/connect-sessions/{token}/imap-accounts
Connect an IMAP account from the hosted page
hostedConnectSessions.createImapAccount 1 param body → 200400401403404409413422
GET
/v1/hosted/connect-sessions/{token}/autoconfig
Find IMAP and SMTP settings from the hosted page
hostedConnectSessions.autoconfig 2 params → 200400401403404409413422
GET
/v1/hosted/meeting-connect-sessions/{token}
Read a hosted meeting connect session
hostedMeetingConnectSessions.get 1 param → 200400401403404409413422
Exports 5
POST
/v1/exports
Export the tenant or one account
exports.create 1 param body → 202400401403409413422429
GET
/v1/exports
List exports, newest first
exports.list 2 params → 200400401403409413422429
GET
/v1/exports/{exportId}
Get an export
exports.get 1 param → 200400401403404409413422
DELETE
/v1/exports/{exportId}
Delete an export and its file
exports.delete 1 param → 204400401403404409413422
GET
/v1/exports/{exportId}/download
Download an export (application/gzip)
exports.download 1 param → 200400401403404409410413
Usage 1
GET
/v1/usage
Read usage and plan limits
usage.get 2 params → 200400401403409413422429
AI 1
POST
/v1/ai/draft
Draft email text with AI
ai.draft 1 param body → 200400401403404409413422
Email validation 2
POST
/v1/email-validations
Validate email addresses
emailValidations.create 1 param body → 200400401403409413422429
GET
/v1/email-validations
List earlier validation results
emailValidations.list 4 params → 200400401403409413422429
Audit log 1
GET
/v1/audit-log
Read the audit log
auditLog.list 9 params → 200400401403409413422429

Schemas 346

The contract defines 346 schemas that model the data the API accepts and returns. The most detailed are TrackingEvent (31 properties), CalendarEventDetail (30 properties), TrackingHitData (29 properties), CalendarEvent (29 properties). Each schema is shown below with its type and property counts.

EventId
string
Address
object
2 properties 2 required
AddressInput
object
2 properties 1 required
BodyStorage
string
EffectiveSettings
object
9 properties 9 required
SettingsOverride
object
9 properties
OptOutHandling
string
McpSendMode
string
McpSendPolicy
object
4 properties 4 required
McpSendPolicyPatch
object
4 properties
TenantSettings
object
14 properties 14 required
UpdateTenantSettings
object
14 properties
OAuthProvider
string
MicrosoftCloud
string
AccountProvider
string
AccountStatus
string
SettableAccountStatus
string
RuntimeState
string
AccountRuntime
object
4 properties 4 required
MailSecurity
string
MailServer
object
4 properties 4 required
DavAuth
string
DavSettings
object
4 properties 4 required
ImapAuth
string
ImapSettings
object
5 properties 5 required
AccountAuthMethod
string
AccountAuth
object
4 properties 4 required
Account
object
19 properties 19 required
SyncKind
string
AccountSyncQueued
object
1 property 1 required
AccountPage
object
2 properties 2 required
CreateAccount
object
7 properties 2 required
AccountToken
object
2 properties 2 required
MailServerInput
object
4 properties 3 required
DavInput
object
4 properties
CreateImapAccount
object
10 properties 2 required
DavDiscoverySource
string
DiscoveredDav
object
3 properties 3 required
AutoconfigSource
string
DiscoveredSettings
object
5 properties 5 required
TemplateSource
string
TemplateFormat
string
TemplateField
string
TemplateSummary
object
8 properties 8 required
Template
object
13 properties 13 required
TemplateSummaryPage
object
2 properties 2 required
RenderParams
object
RenderedTemplate
object
4 properties 4 required
CreateTemplate
object
10 properties 1 required
RenderTemplateRequest
object
8 properties
InputIssue
object
2 properties 2 required
InvalidInputData
object
1 property 1 required
UnknownIdsData
object
1 property 1 required
SyncKindsData
object
1 property 1 required
TemplateFieldData
object
1 property 1 required
MailboxRole
string
MailboxKind
string
Mailbox
object
8 properties 8 required
MailboxList
object
1 property 1 required
MailboxChangedField
string
MessageDirection
string
MessagePriority
string
MessageSummary
object
20 properties 20 required
MessageChangedField
string
MessageSummaryPage
object
2 properties 2 required
Attachment
object
6 properties 6 required
ReplyKind
string
AutoReplyCategory
string
MessageClassification
object
9 properties 9 required
MessageBody
object
2 properties 2 required
Message
object
25 properties 25 required
SearchSource
string
SearchResultSource
string
SearchHit
object
20 properties 20 required
SearchPage
object
3 properties 3 required
PlanModules
object
6 properties 6 required
PlanIncluded
object
4 properties 4 required
PlanStripePrices
object
5 properties 5 required
PlanPricing
object
7 properties 7 required
PlanLimits
object
11 properties 11 required
EffectivePlan
object
3 properties 3 required
UsageDay
object
8 properties 8 required
CurrentUsage
object
5 properties 5 required
Usage
object
3 properties 3 required
McpKeyScope
string
McpKey
object
9 properties 9 required
McpKeyList
object
1 property 1 required
CreatedMcpKey
object
11 properties 11 required
ConnectSessionMcp
object
2 properties 1 required
MailAccess
string
ConnectOptions
object
6 properties
ConnectProvider
string
ConnectSessionStatus
string
ConnectErrorCode
string
ConnectSessionPublic
object
7 properties 7 required
ConnectSession
object
9 properties 9 required
CreateConnectSession
object
11 properties
SessionLink
object
3 properties 3 required
StartOAuthRequest
object
8 properties 2 required
OAuthAuthorization
object
1 property 1 required
HostedImapResult
object
1 property 1 required
MeetingService
string
MeetingConnectionStatus
string
MeetingConnection
object
8 properties 8 required
MeetingConnectionList
object
1 property 1 required
MeetingAppKind
string
MeetingAppStatus
string
MeetingApp
object
12 properties 12 required
MeetingAppList
object
1 property 1 required
CreateMeetingApp
MeetingAppCheck
object
3 properties 3 required
MeetingAppTestResult
object
2 properties 2 required
MeetingConnectSessionPublic
object
5 properties 5 required
CalendarAccess
string
Calendar
object
10 properties 10 required
CalendarList
object
1 property 1 required
CalendarChangedField
string
EventKind
string
AttendeeType
string
ResponseStatus
string
EventStatus
string
ShowAs
string
Sensitivity
string
Attendee
object
4 properties 4 required
EventTime
object
3 properties 3 required
CalendarEvent
object
29 properties 29 required
CalendarEventPage
object
2 properties 2 required
CalendarEventChangedField
string
BodyContentType
string
EventBody
object
2 properties 2 required
CalendarEventDetail
object
30 properties 30 required
EventTimeInput
AttendeeInput
object
3 properties 1 required
RsvpResponse
string
BusyStatus
string
BusyBlock
object
3 properties 3 required
AttendeeAvailability
object
3 properties 3 required
Weekday
string
WorkingHours
object
3 properties 2 required
TimeSlot
object
2 properties 2 required
WithheldReason
string
Availability
object
5 properties 5 required
AvailabilityMode
string
AccountAvailability
object
4 properties 4 required
AccountsTimeSlot
object
3 properties 3 required
AccountsAvailability
object
6 properties 6 required
ContactEmailType
string
ContactPhoneType
string
ContactEmail
object
2 properties 2 required
ContactPhone
object
2 properties 2 required
ContactFolder
object
3 properties 3 required
ContactFolderList
object
1 property 1 required
Contact
object
16 properties 16 required
ContactPage
object
2 properties 2 required
ContactChangedField
string
ContactEmailInput
object
2 properties 1 required
ContactPhoneInput
object
2 properties 1 required
SuppressionSource
string
DetectedOptOutSource
string
SuppressionEntry
object
4 properties 4 required
SuppressionEntryPage
object
2 properties 2 required
SuppressionCounts
object
7 properties 7 required
SuppressionList
object
6 properties 6 required
SuppressionListList
object
1 property 1 required
SuppressionReview
object
9 properties 9 required
SuppressionReviewPage
object
2 properties 2 required
CreateSuppressionList
object
3 properties 2 required
SuppressionAdded
object
1 property 1 required
SuppressionEntriesAdded
object
2 properties 2 required
AttachmentInput
object
4 properties 3 required
OutboxStatus
string
OutboxEntry
object
20 properties 20 required
QueuedSend
object
21 properties 21 required
SendTracking
object
3 properties
MailMergeEntry
object
4 properties 1 required
MailMergeSuccess
object
6 properties 6 required
MailMergeFailure
object
5 properties 5 required
MailMergeResult
MailMergeResultList
object
1 property 1 required
OutboxEntryPage
object
2 properties 2 required
TrackingEventKind
string
TrackingActor
string
TrackingClient
string
TrackingDevice
string
TrackingOs
string
TrackingBrowser
string
TrackingSecFetch
object
4 properties 4 required
TrackingEvent
object
31 properties 31 required
TrackingEventPage
object
2 properties 2 required
AccountConnectedData
object
5 properties 5 required
AccountUpdatedField
string
AccountUpdatedData
object
1 property 1 required
AccountDeletedData
object
3 properties 3 required
AccountReauthRequiredData
object
5 properties 5 required
AccountInitializedData
object
2 properties 2 required
AccountPurgedData
object
2 properties 2 required
MailboxData
object
1 property 1 required
MailboxUpdatedData
object
2 properties 2 required
MailboxRef
object
3 properties 3 required
MessageData
object
2 properties 2 required
MessageUpdatedData
object
3 properties 3 required
MessageDeletedData
object
4 properties 4 required
MessageClassifiedData
object
3 properties 3 required
BounceRecipient
object
3 properties 3 required
MessageBouncedData
object
5 properties 5 required
TrackingHitData
object
29 properties 29 required
SendError
object
2 properties 2 required
SendSentData
object
6 properties 6 required
SendRetryingData
object
5 properties 5 required
SendFailedData
object
4 properties 4 required
SendRescheduledData
object
4 properties 4 required
SuppressionCreatedData
object
3 properties 3 required
CalendarInitializedData
object
2 properties 2 required
CalendarData
object
1 property 1 required
CalendarUpdatedData
object
2 properties 2 required
CalendarEventData
object
1 property 1 required
CalendarEventUpdatedData
object
2 properties 2 required
CalendarEventDeletedData
object
4 properties 4 required
ContactsInitializedData
object
1 property 1 required
ContactData
object
1 property 1 required
ContactUpdatedData
object
2 properties 2 required
ContactDeletedData
object
2 properties 2 required
WebhookTestData
object
1 property 1 required
ExportCompletedData
object
4 properties 4 required
ExportFailedData
object
2 properties 2 required
MeetingConnectionConnectedData
object
3 properties 3 required
MeetingConnectionReauthRequiredData
object
3 properties 3 required
BookingEventData
object
6 properties 6 required
EventType
string
AccountConnectedEvent
object
An account was connected, or an existing account signed in again (reauthorized).
6 properties 5 required
AccountUpdatedEvent
object
An account's status, externalRef, settings or connection changed.
6 properties 5 required
AccountDeletedEvent
object
An account was deleted; its data is purged after the retention period, or at once with purge.
6 properties 5 required
AccountReauthRequiredEvent
object
The provider refused the account's grant: the account must sign in again.
6 properties 5 required
AccountInitializedEvent
object
The account's first mail sync finished; nothing before it is announced message by message.
6 properties 5 required
AccountPurgedEvent
object
A deleted account's data is gone for good (retention, or an immediate purge). The event names no account, since it outlives the account it reports on.
6 properties 5 required
MailboxCreatedEvent
object
A mailbox (folder or label) appeared.
6 properties 5 required
MailboxUpdatedEvent
object
A mailbox was renamed, moved or given another role. Counts change silently.
6 properties 5 required
MailboxDeletedEvent
object
A mailbox went away.
6 properties 5 required
MessageCreatedEvent
object
A message was indexed: received, sent, drafted or moved in from outside the sync window.
6 properties 5 required
MessageUpdatedEvent
object
A message changed: read, flagged, moved, or linked to the outbox entry it is a copy of.
6 properties 5 required
MessageDeletedEvent
object
A message was removed; carries it and its mailboxes as last indexed.
6 properties 5 required
MessageBouncedEvent
object
A delivery status notification reporting failed recipients reached the account; carries the outbox id when it answers one of our sends.
6 properties 5 required
MessageClassifiedEvent
object
AI classified a reply to one of our sends (tenant setting aiReplyClassification): carries the message, its mailboxes and the classification.
6 properties 5 required
MessageOpenedEvent
object
A recipient's client (or a proxy fetching for it) loaded the open-tracking pixel of a send. Carries the actor, its reasons and the derived signals (client, dev…
6 properties 5 required
MessageClickedEvent
object
A tracked link of a send was followed; carries the same as message.opened.
6 properties 5 required
SendSentEvent
object
The provider accepted a queued send.
6 properties 5 required
SendRetryingEvent
object
An attempt failed and the send is queued again for nextAttemptAt.
6 properties 5 required
SendFailedEvent
object
The send failed for good: refused, or out of attempts.
6 properties 5 required
SendRescheduledEvent
object
A queued send got a new sendAt before its first attempt.
6 properties 5 required
SuppressionCreatedEvent
object
An address went onto a suppression list: the recipient unsubscribed (source unsubscribe, listId the send's), a permanent bounce said the address is gone (sourc…
6 properties 5 required
CalendarInitializedEvent
object
The account's first calendar sync finished; nothing before it is announced event by event.
6 properties 5 required
CalendarCreatedEvent
object
A calendar appeared.
6 properties 5 required
CalendarUpdatedEvent
object
A calendar changed.
6 properties 5 required
CalendarDeletedEvent
object
A calendar went away.
6 properties 5 required
CalendarEventCreatedEvent
object
A single event, series or exception appeared. Unmodified occurrences of a series are never announced; an occurrence changed on its own is announced as a new ex…
6 properties 5 required
CalendarEventUpdatedEvent
object
A single event, series or exception changed; a change to a series is one update of the series.
6 properties 5 required
CalendarEventDeletedEvent
object
A single event, series or exception went away.
6 properties 5 required
ContactsInitializedEvent
object
The account's first contacts sync finished; nothing before it is announced contact by contact.
6 properties 5 required
ContactCreatedEvent
object
A contact appeared.
6 properties 5 required
ContactUpdatedEvent
object
A contact changed.
6 properties 5 required
ContactDeletedEvent
object
A contact went away.
6 properties 5 required
ExportCompletedEvent
object
A data export finished and can be downloaded until data.expiresAt. accountId is null for an export of the whole tenant.
6 properties 5 required
ExportFailedEvent
object
A data export failed. accountId is null for an export of the whole tenant.
6 properties 5 required
MeetingConnectionConnectedEvent
object
An account connected (or reconnected) its own grant at a meeting service (Zoom, Webex).
6 properties 5 required
MeetingConnectionReauthRequiredEvent
object
The service refused the account's meeting grant; meetings need a new connect. Mail and calendar sync go on.
6 properties 5 required
BookingCreatedEvent
object
A scheduling link was booked: the account hosts the event, and the invitee is an attendee.
6 properties 5 required
BookingCancelledEvent
object
A booking was cancelled and its event removed.
6 properties 5 required
WebhookTestEvent
object
Sent by the test action to the endpoint it names, whatever that endpoint's filters.
6 properties 5 required
Event
EventFeedPage
object
2 properties 2 required
WebhookMessageFilters
object
7 properties 7 required
WebhookFilters
object
3 properties 3 required
WebhookMessageFiltersInput
object
7 properties
WebhookFiltersInput
object
3 properties
WebhookEndpoint
object
10 properties 10 required
WebhookEndpointList
object
1 property 1 required
WebhookEndpointWithSecret
object
2 properties 2 required
WebhookSecret
object
2 properties 2 required
CreateWebhookEndpoint
object
3 properties 1 required
TestEventSent
object
1 property 1 required
WebhookAttemptResult
string
WebhookAttempt
object
12 properties 12 required
WebhookAttemptPage
object
2 properties 2 required
ReplayResult
object
2 properties 2 required
FailedDeliveryCount
object
1 property 1 required
AiDraftFormat
string
AiDraftContext
object
3 properties
CreateAiDraft
object
3 properties 2 required
AiDraft
object
1 property 1 required
AuditActorType
string
AuditActor
object
3 properties 3 required
AuditSurface
string
AuditOutcome
string
AuditEntry
object
11 properties 11 required
AuditEntryPage
object
2 properties 2 required
Reachability
string
CreateEmailValidation
object
3 properties 1 required
EmailValidationResult
object
13 properties 13 required
EmailValidation
object
1 property 1 required
EmailValidationRecord
object
15 properties 15 required
EmailValidationRecordPage
object
2 properties 2 required
ExportStatus
string
DataExport
object
12 properties 12 required
DataExportPage
object
2 properties 2 required
CreateDataExport
object
1 property
IdentitySource
string
Signature
object
2 properties 2 required
SignatureInput
object
2 properties
Identity
object
6 properties 6 required
IdentityList
object
2 properties 2 required
MailSettings
object
1 property 1 required
GmailPushSettings
object
2 properties 2 required
OAuthApp
object
9 properties 9 required
OAuthAppList
object
1 property 1 required
CreateOAuthApp
object
6 properties 4 required
OrgConnectionKind
string
OrgConnectionStatus
string
MicrosoftAppCredential
string
GoogleDelegation
object
5 properties 5 required
GraphPermission
object
2 properties 2 required
MicrosoftAppAccess
object
4 properties 4 required
OrgConnection
object
12 properties 12 required
OrgConnectionList
object
1 property 1 required
CreateOrgConnection
OrgConnectionCheck
object
4 properties 4 required
OrgConnectionTestResult
object
2 properties 2 required
DirectoryEntry
object
4 properties 4 required
DirectoryEntryPage
object
2 properties 2 required
AddMailboxInput
object
3 properties 1 required
AddedMailboxStatus
string
AddedMailboxError
object
2 properties 2 required
AddedMailbox
object
4 properties 4 required
AddedMailboxList
object
1 property 1 required
ConsentLink
object
1 property 1 required
SchedulingWindow
object
2 properties 2 required
SchedulingHours
object
7 properties
SchedulingLinkFields
object
17 properties 3 required
SchedulingLink
object
20 properties 6 required
SchedulingLinkPage
object
2 properties 2 required
SchedulingSlot
object
3 properties 3 required
SchedulingSlots
object
1 property 1 required
BookingStatus
string
Booking
object
11 properties 11 required
ThreadSummary
object
12 properties 12 required
Thread
object
13 properties 13 required
ThreadSummaryPage
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workwae-com-v1-openapi.json Raw ↑

Other APIs workwae-com publishes across the network.

Workwae API
AE Profile APIs.io
← Back to W APIs
API Details
ID
workwae-com:workwae-api-v1-api
Base URL
https://api.workwae.com
Docs
https://workwae.com/quickstart
Provider
workwae-com
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=workwae-api-v1-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/workwae-api-v1-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Workwae API V1 API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.