v1Resources/Connections/getGet a Facebook connect URL
Get a Facebook connect URL
Returns a Facebook OAuth authorize URL to open in a browser to connect this location's Facebook Page. This endpoint can't complete the connection itself — Facebook's consent screen requires an interactive human.
get
connections:write/api/v1/connections/facebook/connect-urlQuery 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 "/".
Response
dataobjectoptional
providerstring (google | facebook)optional
Which publisher this URL connects.
locationIdstringoptional
The location this connection will be paired to once approved.
urlstringoptional
The authorize URL — open it in a browser under the account owner's control.
notestringoptional
Explains there's no callback to your integration; poll GET /api/v1/connections afterward.
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/facebook/connect-url
Your API key
locationId *
clientId
returnUrl
{
"data": {
"provider": "facebook",
"locationId": "loc_456",
"url": "https://www.facebook.com/v19.0/dialog/oauth?client_id=...&redirect_uri=...&scope=...&state=...&response_type=code",
"note": "Open this URL in a browser under the account owner's control. There is no callback to your integration — once approved, poll GET /api/v1/connections to see the new connection."
}
}