Synup
Create a key
v1Resources/Connections/getGet a Google connect URL

Get a Google connect URL

Returns a Google OAuth authorize URL to open in a browser to connect this location's Google Business Profile. This endpoint can't complete the connection itself — Google's consent screen requires an interactive human.

get/api/v1/connections/google/connect-url
connections:write
Query parameters
locationIdstringrequired
The location to connect.
clientIdstringoptional
The location's client. Only needed to disambiguate when your key is scoped to specific clients.
returnUrlstringoptional
In-app path to land on after the human completes the consent screen. Defaults to "/".
successUrlstringoptional
Where the customer's browser is sent after a successful connect. Must be registered on the API key, and supplied together with errorUrl.
errorUrlstringoptional
Where the browser is sent if the connect fails or is cancelled. Same registration rule, and supplied together with successUrl.
Response
dataobjectoptional
providerstring (google | facebook | apple)optional
Which publisher this URL connects: google, facebook, or apple.
locationIdstringoptional
The location this connection pairs to, or null when the connect was started with a clientId.
clientIdstringoptional
The client this connection is scoped to, or null.
urlstringoptional
The authorize URL — open it in a browser under the account owner's control.
successUrlstringoptional
The successUrl used for this call, or null in legacy mode.
errorUrlstringoptional
The errorUrl used for this call, or null in legacy mode.
notestringoptional
Guidance for opening the URL. Explains the partner handoff when successUrl and errorUrl are set, or the poll GET /api/v1/connections flow otherwise.
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
429Too many requests. Retry after the number of seconds in the Retry-After header.
get/api/v1/connections/google/connect-url
Your API key
locationId *
clientId
returnUrl
successUrl
errorUrl
{
  "data": {
    "provider": "google",
    "locationId": "loc_456",
    "clientId": null,
    "url": "https://accounts.google.com/o/oauth2/v2/auth?client_id=...&redirect_uri=...&response_type=code&scope=...&state=...",
    "successUrl": "https://app.example.com/oauth/done",
    "errorUrl": "https://app.example.com/oauth/failed",
    "note": "Open this URL in a browser under the account owner's control. When the connect settles, the browser is sent to your successUrl (with ?code=...&status=...&connected_account_id=...) or errorUrl (with ?error=...). Exchange the code server-side at POST /api/v1/connections/handoff/exchange within 10 minutes for the connection id and the email that authorised."
  }
}

Guides that use this endpoint