Read the outcome of a mailbox connection

GET

/emails/{email_provider}/oauth/result

const url = 'https://api.clearance.rest/emails/gmail/oauth/result?token=example';
const options = {method: 'GET', headers: {'X-API-Key': '<X-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 'https://api.clearance.rest/emails/gmail/oauth/result?token=example' \
  --header 'X-API-Key: <X-API-Key>'

Single use: the token is consumed by the first read and expires 10 minutes after the browser returned. A failed connection is a successful read with status: failed and an error code.

Authorizations

ApiKeyAuth

Parameters

Path Parameters

email_provider

required

string

Allowed values: gmail outlook

Email provider that can be connected with OAuth.

Query Parameters

token

required

string

>= 1 characters

The result_token from the return_url.

Responses

200

Default Response

application/json

object

success

required

boolean

status

required

string

Allowed values: connected failed

email

required

string | null

email_provider

required

Email provider that can be connected with OAuth.

string

Allowed values: gmail outlook

error

required

Any of:

object
null

object

code

required

string

message

required

string

client_state

required

string | null

Example

{
  "success": true,
  "status": "connected",
  "email_provider": "gmail"
}

401

Default Response

application/json

Error envelope returned by every JSON endpoint.

object

success

required

boolean

error

required

object

code

required

Machine-readable error code (snake_case).

string

message

required

Human-readable message.

string

details

Extra context for the error.

object

key

additional properties

Example

{
  "success": false
}

403

Default Response

application/json

Error envelope returned by every JSON endpoint.

object

success

required

boolean

error

required

object

code

required

Machine-readable error code (snake_case).

string

message

required

Human-readable message.

string

details

Extra context for the error.

object

key

additional properties

Example

{
  "success": false
}

404

Default Response

application/json

Error envelope returned by every JSON endpoint.

object

success

required

boolean

error

required

object

code

required

Machine-readable error code (snake_case).

string

message

required

Human-readable message.

string

details

Extra context for the error.

object

key

additional properties

Example

{
  "success": false
}