Skip to content
clearance.rest

Overview

Wait for an inbound email, extract a code from it, and connect Gmail or Outlook mailboxes.

Emails API 1.0.0

Section titled “Emails API 1.0.0”

GET /get-email holds the request open until a matching email arrives and then returns it. It does not care where the email came from: the recipient can be an address on a Cloudflare-routed domain or a Gmail or Outlook mailbox you connected through the OAuth endpoints. The client sees no difference.

A wait lasts at most 5 minutes. Send X-Service-Timeout to give up sooner.

Information

  • License: MIT
  • OpenAPI version: 3.1.0

Operations

Section titled “Operations”
GET
/get-email
GET
/attachments/{key}
GET
/{provider}/oauth/start
GET
/{provider}/oauth/result
GET
/{provider}/accounts
POST
/{provider}/accounts/disconnect

Authentication

Section titled “Authentication”

ApiKey

Section titled “ApiKey”

Your project’s API key (cr_live_…), shown on the project page in the console. Clients that cannot send headers may pass it as the api_key query parameter instead. A missing or invalid key returns 401.

Security scheme type: apiKey

Header parameter name: X-API-Key