GETapi.synup.com/api/v4/folder-locations

List locations under a folder

This API retrieves all locations within a specified folder and its subfolders.

Response Includes:

Business details (name, category, address)
Contact information (phone, email, website)
Metadata (tags, attributes, custom fields)

Requires an API key. Send it as Authorization: API <your-key> — see Getting started.

Parameters

Query

Name	Type	Required	Description
`folderName`	string	optional	Name of the folder to fetch locations from
`folderId`	string	optional	Unique identifier of the folder

Request

curl -X GET 'https://api.synup.com/api/v4/folder-locations?folderName=&folderId=' \
  -H 'Authorization: API YOUR_API_KEY' \
  -H 'Content-Type: application/json'

const res = await fetch('https://api.synup.com/api/v4/folder-locations?folderName=&folderId=', {
  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/folder-locations?folderName=&folderId=",
    headers={
        "Authorization": "API YOUR_API_KEY",
        "Content-Type": "application/json",
    },
)
data = res.json()

req, _ := http.NewRequest("GET", "https://api.synup.com/api/v4/folder-locations?folderName=&folderId=", 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`	Successfully retrieved locations
`400`	Bad request - Invalid parameters
`403`	Unauthorized - insufficient permissions to access folder
`404`	Folder not found

Example response (generated from the schema)

{
  "data": {
    "getLocationsForFolder": [
      {}
    ]
  }
}

Response body

Name	Type	Required	Description
`data`	object	optional
`data.getLocationsForFolder`	array of object	optional