Skip to main content
GET
Poll OAuth connect

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

provider
enum<string>
required
Available options:
google,
microsoft

Query Parameters

state
string
required

The state returned by init.

Example:

"aB3dEf6hIjKlMnOpQrStUvWxYz0123456789_-AbCdE"

Response

status
enum<string>
required

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

Available options:
pending,
connected,
failed
accountId
string | null
required

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

Example:

"3f1c2b7e-9a4d-4e18-b2c1-6d8f5a0e7c93"

error
string | null
required

Failure reason when status is failed.

Example:

"The mailbox owner denied access."