Skip to content

Outlook Connector

Connect Microsoft Outlook mailboxes. Shared OAuth flow uses integration: "outlook".

Base URL

BASE_URL = "https://api.fermi.dev/public/v1"

Authentication

Authorization: Bearer <service-actor-token>

Required Scopes: connectors:read, connectors:write, connectors:sync

Connect

POST /connect/integrations/connect-session

{
  "integration": "outlook"
}
curl --request POST \
  --url "${BASE_URL}/connect/integrations/connect-session" \
  --header "Authorization: Bearer <token>" \
  --header "Content-Type: application/json" \
  --data '{"integration": "outlook"}'

Response: { "sessionToken": "..." } — complete OAuth with the connect session token.

List connections

GET /connect/integrations/connections?providerConfigKey=outlook

User info

GET /connect/integrations/user-info?connectionId={connectionId}&providerConfigKey=outlook

Metadata and sync

POST /connect/integrations/connection-metadata

{
  "connectionId": "CONNECTION_ID",
  "providerConfigKey": "outlook",
  "metadata": {
    "connectionName": "Work Outlook"
  },
  "triggerSyncEnqueue": true
}

Outlook metadata writes do not enqueue sync unless triggerSyncEnqueue is true.

POST /sync/enqueue

{
  "connectionId": "CONNECTION_ID",
  "providerKey": "outlook"
}

Summary

Method Path
POST /connect/integrations/connect-session
GET /connect/integrations/connections?providerConfigKey=outlook
GET /connect/integrations/user-info
POST /connect/integrations/connection-metadata
POST /sync/enqueue

Next Steps