GETapi.synup.com/api/v4/connected-accounts/apple-confirmed-matches

Apple confirmed matches

Returns the confirmed matches between Synup locations and Apple Business listings for a connected Apple account. These are produced after a location has been connected via the Apple Business Connect OAuth flow (see Connect link for Apple). Results are paginated.

Requires an API key. Send it as Authorization: API <your-key> — see Getting started.

Parameters

Query

Name	Type	Required	Description
`accountId`	string	required	Account ID.
`connectedAccountId`	string	required	ID of the connected Apple account.
`page`	integer	required	Page number (1-based).

Headers

Name	Type	Required	Description
`Synup-Version`	string	required	API version date (YYYY-MM-DD).

Request

curl -X GET 'https://api.synup.com/api/v4/connected-accounts/apple-confirmed-matches?accountId=&connectedAccountId=&page=' \
  -H 'Authorization: API YOUR_API_KEY' \
  -H 'Content-Type: application/json'

const res = await fetch('https://api.synup.com/api/v4/connected-accounts/apple-confirmed-matches?accountId=&connectedAccountId=&page=', {
  method: 'GET',
  headers: {
    Authorization: 'API YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
});
const data = await res.json();

import requests
res = requests.get(
    "https://api.synup.com/api/v4/connected-accounts/apple-confirmed-matches?accountId=&connectedAccountId=&page=",
    headers={
        "Authorization": "API YOUR_API_KEY",
        "Content-Type": "application/json",
    },
)
data = res.json()

req, _ := http.NewRequest("GET", "https://api.synup.com/api/v4/connected-accounts/apple-confirmed-matches?accountId=&connectedAccountId=&page=", nil)
req.Header.Set("Authorization", "API YOUR_API_KEY")
req.Header.Set("Content-Type", "application/json")

res, err := http.DefaultClient.Do(req)

Responses

Status	Description
`200`	Successful response
`401`	Unauthorized - Invalid or missing API key

Example response (generated from the schema)

{
  "data": {
    "appleConfirmedMatches": {
      "matches": [
        {
          "id": "string",
          "appleBusinessId": "string",
          "connectedAccountId": "string",
          "connectedAccountLabel": "string",
          "connectedAccountsLocationId": "string",
          "lakeRecordId": "string",
          "matchedOn": "2026-01-01T00:00:00Z",
          "synupLocationId": 0
        }
      ],
      "matchesCount": 0,
      "pages": 0
    }
  }
}

Response body

Name	Type	Required	Description
`data`	object	optional
`data.appleConfirmedMatches`	object	optional
`data.appleConfirmedMatches.matches`	array of object	optional
`data.appleConfirmedMatches.matches[].id`	string	optional
`data.appleConfirmedMatches.matches[].appleBusinessId`	string	optional
`data.appleConfirmedMatches.matches[].connectedAccountId`	string	optional
`data.appleConfirmedMatches.matches[].connectedAccountLabel`	string	optional
`data.appleConfirmedMatches.matches[].connectedAccountsLocationId`	string	optional
`data.appleConfirmedMatches.matches[].lakeRecordId`	string	optional
`data.appleConfirmedMatches.matches[].matchedOn`	string	optional
`data.appleConfirmedMatches.matches[].synupLocationId`	integer	optional
`data.appleConfirmedMatches.matchesCount`	integer	optional	Total number of matches.
`data.appleConfirmedMatches.pages`	integer	optional	Total number of pages.