---
title: "List locations under a folder"
method: GET
path: "/folder-locations"
tags: ["Organizing locations", "Folders"]
---

# List locations under a folder

`GET /folder-locations`

## Request

- Base URL: `https://api.synup.com/api/v4`
- URL: `https://api.synup.com/api/v4/folder-locations`
- Auth: none required
- TypeScript: <https://skmtc.dev/synup/apis/synup-api/docs/folder-locations/get.ts> (a function with typed inputs; its response is checked against the schema)

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.

:::

## Query parameters

- `folderName` string
- `folderId` string

## Headers

- `Authorization` string

## Response `200`

Successfully retrieved locations

- object
  - `data` object
    - `getLocationsForFolder` object[]

## Other responses

- `400`: Bad request - Invalid parameters
- `403`: Unauthorized - insufficient permissions to access folder
- `404`: Folder not found

---

[API](https://skmtc.dev/synup/apis/synup-api.md) - [All operations](https://skmtc.dev/synup/apis/synup-api/llms.txt) - [OpenAPI document](https://skmtc.dev/synup/apis/synup-api/revisions/67de2d51c22e?raw)