Start Google Sign-in
Get the Google consent URL for connecting a Gmail account.
https://api.foxreach.io/api/v1/email-accounts/google-oauth/startRequires an API key with the write scope.
Returns the Google consent URL. An API key cannot finish a consent flow on its own: open the URL in a browser, sign in to Google and approve. FoxReach connects the account to the workspace of the API key when Google redirects back. There is no API route for the callback, so the connection is only complete once someone has approved it in the browser, and the new account appears in List Email Accounts afterwards.
The link carries a signed state token that is valid for 10 minutes. Request a new URL if it expires. There is no request body.
Response#
dataobjectResult.
Show data
urlstringErrors#
| Status | Description |
|---|---|
401 | Missing, invalid, revoked or expired API key |
403 | API key does not have the required scope: write |
503 | Google OAuth is not configured on environments without Google credentials |
Rate Limit#
- 100 requests per minute, per API key. Fixed 60-second window.
- Every response includes
X-RateLimit-Limit,X-RateLimit-Remaining, andX-RateLimit-Reset(unix epoch seconds). - A
429response includes aRetry-Afterheader (seconds until the bucket resets).
For client-side patterns (Retry-After, exponential backoff, monitoring X-RateLimit-Remaining), see Rate Limiting.