Synup
Create a key
v1Resources/Connections/getGet an Apple connect URL

Get an Apple connect URL

Returns an Apple Business Connect authorize URL to open in a browser. Takes locationId or clientId, at least one; when locationId is supplied, the listing binds server-side with no picker step.

get/api/v1/connections/apple/connect-url
connections:write
Query parameters
locationIdstringoptional
The location to connect. Optional for Apple: pass locationId or clientId, at least one.
clientIdstringoptional
The location's client. Only needed to disambiguate when your key is scoped to specific clients.
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/apple/connect-url
Your API key
locationId
clientId
successUrl
errorUrl
{
  "data": {
    "provider": "apple",
    "locationId": "loc_456",
    "clientId": null,
    "url": "https://businessconnect.apple.com/authorize?client_id=...&redirect_uri=...&scope=...&state=...",
    "successUrl": null,
    "errorUrl": null,
    "note": "Open this URL in a browser under the account owner's control. Apple's account represents the business itself, so with a locationId supplied the listing binds server-side with no picker step. There is no callback; poll GET /api/v1/connections, or pass successUrl and errorUrl to get a one-time code back."
  }
}

Guides that use this resource