Connectors (Integrations)

Get connector

Returns a connector for the specified provider.

get/v3/connectors/{provider}

Path parameters

provider'google' | 'microsoft' | 'imap' | 'icloud' | 'yahoo' | 'ews' | 'virtual-calendar' | 'zoom' | 'nylas' required
Example:google

Response

Returns a connector object

request_idstring

ID of the request

Example response

{
  "request_id": "5967ca40-a2d8-4ee0-a0e0-6f18ace39a90",
  "data": {
    "name": "Google Connector",
    "provider": "google",
    "settings": {
      "topic_name": "abc123"
    },
    "scope": [
      "https://www.googleapis.com/auth/userinfo.email",
      "https://www.googleapis.com/auth/userinfo.profile"
    ],
    "active_credential_id": "c123f8e1a-eb1c-41c0-b6a6-d2e59daf7f47"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.