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
| Name | Type | Required | Description |
|---|---|---|---|
locationId | string | required | Location 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'const res = await fetch('https://api.synup.com/api/v4/locations/:locationId/photos', {
method: 'GET',
headers: {
Authorization: 'API YOUR_API_KEY',
'Content-Type': 'application/json',
},
});
const data = await res.json();import requests
res = requests.get(
"https://api.synup.com/api/v4/locations/:locationId/photos",
headers={
"Authorization": "API YOUR_API_KEY",
"Content-Type": "application/json",
},
)
data = res.json()req, _ := http.NewRequest("GET", "https://api.synup.com/api/v4/locations/:locationId/photos", nil)
req.Header.Set("Authorization", "API YOUR_API_KEY")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)Responses
| Status | Description |
|---|---|
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
| Name | Type | Required | Description |
|---|---|---|---|
data | object | required | |
data.mediaFilesOfLocation | array of object | required | |
data.mediaFilesOfLocation[].id | string | required | |
data.mediaFilesOfLocation[].url | string | required | |
data.mediaFilesOfLocation[].uploadedBy | null | required | |
data.mediaFilesOfLocation[].fileName | string | required | |
data.mediaFilesOfLocation[].fileSize | string | required | |
data.mediaFilesOfLocation[].fileType | string | required | |
data.mediaFilesOfLocation[].fileExtension | string | required | |
data.mediaFilesOfLocation[].archived | boolean | required | |
data.mediaFilesOfLocation[].accountId | integer | required | |
data.mediaFilesOfLocation[].thumbnailUrl | string | required | |
data.mediaFilesOfLocation[].starred | boolean | required | |
data.mediaFilesOfLocation[].category | object | required | |
data.mediaFilesOfLocation[].category.name | string | required | |
data.mediaFilesOfLocation[].category.id | integer | required | |
data.mediaFilesOfLocation[].mediaLabels | array of string | required | |
data.mediaFilesOfLocation[].fileDimensions | object | required | |
data.mediaFilesOfLocation[].fileDimensions.height | integer | required | |
data.mediaFilesOfLocation[].fileDimensions.width | integer | required | |
data.mediaFilesOfLocation[].uploadedAt | string | required | |
data.mediaFilesOfLocation[].locationId | string | required | |
data.mediaFilesOfLocation[].publisherOverride | string | required |