Synup

Retrieve Premium Listings for a Location

GET/locations/{locationID}/listings/premium

This endpoint retrieves premium listings for a specified location.

The location is identified by a unique ID included in the URL path.

Authorization Required: This endpoint requires an API key.
Location ID: Use a valid location ID in the path.
API Key: Pass API key as Bearer token in Authorization header.

Request

Path Params

locationID

string

required

Example:

TG9jYXRpb246MTA2MDY4MQ==

Header Params

Authorization

string

required

Your API key for authentication. Use the format:

Authorization: API rnYm2SBgqH8dTOizP9BeT0IntSI

Example:

API rnYm2SBgqH8dTOizP9BeT0IntSI

Request samples

Responses

OK(200)

Unauthorized(401)

Record Not Found(404)

HTTP Code: 200

Content Type : JSONapplication/json

A successful response containing the premium listings for the
specified location.

data

object

required

listingsForLocation

array [object {11}]

required

listings

array [object {3}]

optional

A list of premium listings.

string

optional

The unique identifier for the listing.

title

string

optional

The title of the premium listing.

url

string

optional

The URL of the listing.

{
  "data": {
    "listingsForLocation": [
      {
        "actionRequired": true,
        "connectedAccountId": "acct_001",
        "databaseId": "db_001",
        "id": "listing_001",
        "lastUpdate": "2023-11-06T12:34:56Z",
        "listingUrl": "https://example.com/listing_001",
        "site": {
          "id": "site_001",
          "databaseId": "db_site_001",
          "name": "Example Site",
          "syScore": 85,
          "url": "https://example.com/site_001"
        },
        "syncIssue": "None",
        "syncStatus": "Active",
        "displayStatus": "Visible",
        "verified": true
      }
    ]
  },
  "listings": [
    {
      "id": "listing_001",
      "title": "Sample Listing",
      "url": "https://example.com/listing_001"
    }
  ]
}

Last modified: 5 days ago