Skip to content
SynupAPI
Get an API key

LocationConnectionsResponse

Fields

NameTypeRequiredDescription
dataobjectoptional
data.locationsConnectInfoobjectoptional
data.locationsConnectInfo.pageInfoobjectoptional
data.locationsConnectInfo.pageInfo.hasNextPagebooleanoptionalIndicates if there are more pages available
data.locationsConnectInfo.pageInfo.hasPreviousPagebooleanoptionalIndicates if there are previous pages available
data.locationsConnectInfo.pageInfo.totalPagesintegeroptionalTotal number of pages available
data.locationsConnectInfo.pageInfo.totalRecordsintegeroptionalTotal number of records across all pages
data.locationsConnectInfo.recordsarray of objectoptional
data.locationsConnectInfo.records[].locationIdstringoptionalBase64-encoded location id (Location:<id>)
data.locationsConnectInfo.records[].accountIdstringoptionalAccount id the location belongs to
data.locationsConnectInfo.records[].clientNamestringoptionalClient / sub-account name
data.locationsConnectInfo.records[].accountTypestringoptionalSource / publisher this record represents
GoogleAccountFacebookAccountAppleAccountYelpAccountTripadvisorAccount
data.locationsConnectInfo.records[].statusstringoptionalRaw connection status of the location for this source. Values include CONNECTED, NOT_CONNECTED, CONNECTION_ISSUE, EXPIRED, RENEW, MISSING, SUSPENDED, etc.
data.locationsConnectInfo.records[].connectedAccountIdstringoptionalId of the connected account, when connected
data.locationsConnectInfo.records[].providerIdstringoptionalProvider-side id of the connected listing, when connected
data.locationsConnectInfo.records[].accountMailstringoptionalEmail of the connected (publisher) account, when connected
data.locationsConnectInfo.records[].publisherAccountNamestringoptionalDisplay name of the connected publisher account
data.locationsConnectInfo.records[].publisherAccountIdstringoptionalId of the connected publisher account
data.locationsConnectInfo.records[].listingSiteIdintegeroptionalSite id of the connected listing
data.locationsConnectInfo.records[].locationInfoobjectoptional
data.locationsConnectInfo.records[].locationInfo.approvedbooleanoptionalWhether the location is approved
data.locationsConnectInfo.records[].locationInfo.namestringoptionalLocation name
data.locationsConnectInfo.records[].locationInfo.streetstringoptionalStreet address line 1
data.locationsConnectInfo.records[].locationInfo.street1stringoptionalStreet address line 2
data.locationsConnectInfo.records[].locationInfo.citystringoptionalCity
data.locationsConnectInfo.records[].locationInfo.postalCodestringoptionalPostal / ZIP code
data.locationsConnectInfo.records[].locationInfo.countryIsostringoptionalISO country code (e.g. IN, US)
data.locationsConnectInfo.records[].locationInfo.storeCodestringoptionalStore code of the location, if set
data.locationsConnectInfo.records[].locationInfo.liveLinkstringoptionalPublic live link of the location's listing on the source
data.locationsConnectInfo.records[].connectedListingInfoone ofoptionalDetails of the connected listing on the source. null when the location is not connected. When present, its shape depends on the source.
data.locationsConnectInfo.records[].connectedListingInfo.namestringoptional
data.locationsConnectInfo.records[].connectedListingInfo.addressLinesarray of stringoptional
data.locationsConnectInfo.records[].connectedListingInfo.administrativeAreastringoptional
data.locationsConnectInfo.records[].connectedListingInfo.localitystringoptional
data.locationsConnectInfo.records[].connectedListingInfo.regionCodestringoptional
data.locationsConnectInfo.records[].connectedListingInfo.postalCodestringoptional
data.locationsConnectInfo.records[].connectedListingInfo.phonestringoptional
data.locationsConnectInfo.records[].connectedListingInfo.storeCodestringoptional
data.locationsConnectInfo.records[].connectedListingInfo.gmbAccountNumberstringoptional
data.locationsConnectInfo.records[].connectedListingInfo.gmbGroupstringoptional
data.locationsConnectInfo.records[].connectedListingInfo.suspendedbooleanoptional
data.locationsConnectInfo.records[].connectedListingInfo.liveLinkstringoptional
data.locationsConnectInfo.records[].connectedListingInfo.streetstringoptional
data.locationsConnectInfo.records[].connectedListingInfo.citystringoptional
data.locationsConnectInfo.records[].connectedListingInfo.statestringoptional
data.locationsConnectInfo.records[].connectedListingInfo.zipstringoptional
data.locationsConnectInfo.records[].connectedListingInfo.countrystringoptional
data.locationsConnectInfo.records[].connectedListingInfo.parentPageNamestringoptional