Email Accounts

Poll OAuth connect

Poll a connect started with init. pending until the mailbox owner finishes consent, then connected (with accountId) or failed.

Requires one of the following scopes: accounts:read, accounts:all, all:read, all:all.

get/v1/accounts/oauth/{provider}/status

Request

  • Base URL: https://api.mailbeast.ai
  • URL: https://api.mailbeast.ai/v1/accounts/oauth/{provider}/status
  • Auth: HTTP bearer

Path parameters

provider'google' | 'microsoft' required

Query parameters

statestring required
Example:aB3dEf6hIjKlMnOpQrStUvWxYz0123456789_-AbCdE

The state returned by init.

Response

status'pending' | 'connected' | 'failed' required

pending until consent completes, then connected (with accountId) or failed.

accountIdstring nullable required

The connected account id once status is connected; otherwise null.

errorstring nullable required

Failure reason when status is failed.

Example response

{
  "accountId": "3f1c2b7e-9a4d-4e18-b2c1-6d8f5a0e7c93",
  "error": "The mailbox owner denied access."
}

Changes

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