PilotFoxDocs
REST APIAPI referenceSearch Console

Start a Search Console connection

POST
/api/v1/orgs/{orgId}/search-console/connect

Starts Google's OAuth consent for a new connection and answers the URL to send the browser to; Google then returns to the OAuth callback, which sends the browser on to returnTo (a path of the web app). Signed-in users only (403 for API keys and MCP tokens); 503 when Google OAuth is not configured.

Requires organization:update in the organization (an API key, or a signed-in member's role; a member restricted to some sites holds a viewer's permissions here). API keys limited to some sites: 403. Share links: 401.

Authorization

headerx-api-key<token>

An organization API key (ak_…), with the permissions and the sites it was created with. For servers and scripts: no cookie and no Origin check. Also accepted as Authorization: Bearer ak_… (apiKeyBearer). A request carries one credential: a key sent with a share token or a live session cookie is 400 (details.reason: ambiguous_credentials).

Scope: organization:update

Path Parameters

orgId*string

Request Body

application/json
  1. body
returnTo?string
Lengthlength <= 512

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X POST 'https://pilotfox.app/api/v1/orgs/string/search-console/connect' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response200
{  "data": {    "url": "string"  }}