Skip to content
SynupAPI
Get an API key
GETapi.synup.com/api/v4/locations/{locationId}/photosBeta

Get Photos by Location IDs

This API allows returns all media files of a specific location.

For more details, refer to Photo specifications for your business location markdown.

This endpoint is marked Beta. It is live, but its request or response shape may still change.
Requires an API key. Send it as Authorization: API <your-key> — see Getting started.

Parameters

Path

NameTypeRequiredDescription
locationIdstringrequiredLocation ID should be provided in Base64 encoded format. Must be in the format Location:<Location ID>

Request

Request
curl -X GET 'https://api.synup.com/api/v4/locations/:locationId/photos' \
  -H 'Authorization: API YOUR_API_KEY' \
  -H 'Content-Type: application/json'

Responses

StatusDescription
200
400
x-200:Example Response (Over 30 Photos)
Example response (generated from the schema)
{
  "data": {
    "mediaFilesOfLocation": [
      {
        "id": "string",
        "url": "string",
        "uploadedBy": null,
        "fileName": "string",
        "fileSize": "string",
        "fileType": "string",
        "fileExtension": "string",
        "archived": true,
        "accountId": 0,
        "thumbnailUrl": "string",
        "starred": true,
        "category": {
          "name": "string",
          "id": 0
        },
        "mediaLabels": [
          "string"
        ],
        "fileDimensions": {
          "height": 0,
          "width": 0
        },
        "uploadedAt": "string",
        "locationId": "string",
        "publisherOverride": "string"
      }
    ]
  }
}

Response body

NameTypeRequiredDescription
dataobjectrequired
data.mediaFilesOfLocationarray of objectrequired
data.mediaFilesOfLocation[].idstringrequired
data.mediaFilesOfLocation[].urlstringrequired
data.mediaFilesOfLocation[].uploadedBynullrequired
data.mediaFilesOfLocation[].fileNamestringrequired
data.mediaFilesOfLocation[].fileSizestringrequired
data.mediaFilesOfLocation[].fileTypestringrequired
data.mediaFilesOfLocation[].fileExtensionstringrequired
data.mediaFilesOfLocation[].archivedbooleanrequired
data.mediaFilesOfLocation[].accountIdintegerrequired
data.mediaFilesOfLocation[].thumbnailUrlstringrequired
data.mediaFilesOfLocation[].starredbooleanrequired
data.mediaFilesOfLocation[].categoryobjectrequired
data.mediaFilesOfLocation[].category.namestringrequired
data.mediaFilesOfLocation[].category.idintegerrequired
data.mediaFilesOfLocation[].mediaLabelsarray of stringrequired
data.mediaFilesOfLocation[].fileDimensionsobjectrequired
data.mediaFilesOfLocation[].fileDimensions.heightintegerrequired
data.mediaFilesOfLocation[].fileDimensions.widthintegerrequired
data.mediaFilesOfLocation[].uploadedAtstringrequired
data.mediaFilesOfLocation[].locationIdstringrequired
data.mediaFilesOfLocation[].publisherOverridestringrequired