PilotFoxDocs
REST APIAPI referenceSearch Console

Get the organization's Search Console connections

GET
/api/v1/orgs/{orgId}/search-console

Whether Google OAuth is configured on the instance, the redirect URI and scope to register with Google, and the organization's Google connections.

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

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X GET 'https://pilotfox.app/api/v1/orgs/string/search-console'
Example Response200
{  "data": {    "configured": true,    "source": "dedicated",    "redirectUri": "string",    "scope": "string",    "connections": [      {        "id": "string",        "googleEmail": "string",        "status": "active",        "lastError": "string",        "lastErrorAt": "string",        "scopes": [          "string"        ],        "createdAt": "string",        "createdBy": {          "name": "string",          "email": "string"        },        "sites": [          {            "id": "string",            "name": "string"          }        ]      }    ]  }}