SYsynup
Connected Accounts
Connected Accounts

List location connections

This API returns a paginated list of your locations paired with each publisher (source), along with whether that location is connected, not connected, or has a connection issue for that publisher. It is the direct API equivalent of the <strong>Location Connections</strong> page.

Features:

  • Pagination support – retrieve results in batches for efficient processing.
  • Filtering options – filter location connections by:
    • Source / publisher (source)
    • Location id (locationId)
    • Location name / address / phone (locationName)
    • Connection status (status)
  • Sorting – order by location info, publisher account email, or publisher type.
get/location-connections

Request

Query parameters

source'GoogleAccount' | 'FacebookAccount' | 'AppleAccount' | 'YelpAccount' | 'TripadvisorAccount'

Publisher (source) to filter by. Accepted values

  • GoogleAccount
  • FacebookAccount
  • AppleAccount
  • YelpAccount
  • TripadvisorAccount
locationIdstring

Filter by one or more location ids. Accepts a raw numeric location id (e.g. 279169) or a comma-separated list (e.g. 279169,279170). Base64-encoded ids (Location:<id>) are also accepted.

locationNamestring

Free-text search across the location name, address, and phone number.

status'Connected' | 'NotConnected' | 'ConnectionIssue'

Connection status to filter by.

  • Connected - location is connected to the source
  • NotConnected - location is not connected to the source
  • ConnectionIssue - location has a connection issue for the source
sortField'location_info' | 'account_mail' | 'account_type'

Field to sort the results by.

  • location_info
  • account_mail
  • account_type
sortOrder'Ascending' | 'Descending'

Sort order. Only applied when sortField is provided.

  • Ascending
  • Descending
pageinteger

Page number for pagination

perPageinteger

Number of records per page

Headers

Authorizationstring required

API key for authentication

Response

Successfully retrieved location connections

Changes

No recorded changes to this operation across all 1 revision of this API.