Organizing locations
Folders
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)
:::info[]
Note: Either folderId or folderName must be provided.
:::
get/folder-locations
Request
- Base URLhttps://api.synup.com/api/v4
- Authnone required
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
folderNamestring
Name of the folder to fetch locations from
folderIdstring
Unique identifier of the folder
Headers
Authorizationstring
API key for authentication
Response
Successfully retrieved locations
Changes
No recorded changes to this operation across all 1 revision of this API.