Configured email providers and this user's connected accounts

GET

/api/v1/email/connections

const url = 'http://localhost:11044/api/v1/email/connections';
const options = {method: 'GET', headers: {'X-Embabel-Api-Key': '<X-Embabel-Api-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:11044/api/v1/email/connections \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

Authorizations

apiKeyAuth
basicAuth

Responses

200

*/*

The signed-in user’s email connection state, answered by GET /email/connections.

object

accounts

required

The email accounts this user has connected, across every provider

Array<object>

One account the signed-in user has connected; it never carries a credential. Listed by GET /email/connections and GET /calendar/connections.

object

accountId

required

The provider’s stable identifier for the account, typically its email address; the id DELETE /email/connections/{accountId} takes

string

displayName

required

Label recorded for the account when it was connected, for showing in a UI

string

provider

required

Key of the provider the account was connected through; matches a provider’s providerName

string

providers

required

Every email provider registered on this appliance

Array<object>

A provider this appliance can connect accounts with, and where to start connecting one. Listed by GET /email/connections and GET /calendar/connections.

object

authorizeUrl

required

Path on this server that starts the provider’s OAuth flow; send the browser there to connect an account

string

configured

required

True when the provider is set up on this appliance, so an account can be connected through it

boolean

displayName

required

Name to show for the provider, such as Google

string

providerName

required

Provider key, such as google-workspace or microsoft-graph; the value a connected account’s provider carries

string