Synupv1
Create a key
v1Resources/Media/getGet location media

Get location media

Returns the logo, photos, and videos on file for one location, grouped by category.

get/api/v1/media
media:read
Query parameters
locationIdstringrequired
The location to look up. Required.
Response
dataobjectoptional
locationIdstringoptional
The location this media belongs to.
logoUrlstringoptional
URL of the location's logo, or null.
mediaByCategoryobjectoptional
Media items grouped by category (e.g. EXTERIOR, INTERIOR, FOOD_AND_DRINK, LOGO, TEAMS). Each item has a url, and optionally a label, kind (PHOTO or VIDEO), source, starred flag, and asset key.
photosSummaryobjectoptional
Aggregate photo counts.
totalnumberoptional
Total number of photos, or null.
byCategoryarray of objectoptional
Photo count per category.
categorystringoptional
countnumberoptional
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.
404The resource wasn't found, or doesn't belong to your agency.
429Too many requests. Retry after the number of seconds in the Retry-After header.
get/api/v1/media
Your API key
locationId *
{
  "data": {
    "locationId": "loc_456",
    "logoUrl": "https://cdn.synup.com/logos/loc_456.png",
    "mediaByCategory": {
      "EXTERIOR": [
        {
          "url": "https://cdn.synup.com/media/1.jpg",
          "kind": "PHOTO",
          "source": "user_upload",
          "starred": true
        }
      ]
    },
    "photosSummary": {
      "total": 12,
      "byCategory": [
        {
          "category": "EXTERIOR",
          "count": 4
        }
      ]
    }
  }
}