---
title: "List folders"
method: GET
path: "/v1/sites/{site_id}/folders"
tags: ["Folders"]
---

# List folders

`GET /v1/sites/{site_id}/folders`

## Request

- Base URL: `https://api.getsitecontrol.com`
- URL: `https://api.getsitecontrol.com/v1/sites/{site_id}/folders`
- Auth: HTTP bearer

Folders of one kind of item, as in the admin: General first, with id 0, then
the others in the admin's order. Every folder comes in one page, with the
number of its live items (`counts`). Call it for the `folder_id` the item
lists filter by and `update_widgets` moves into, and for the ids
`update_folder` renames.

## Path parameters

- `site_id` integer, required

## Query parameters

- `type` 'widget' | 'segment' | 'broadcast' | 'automation', required: The items a folder holds. widget: widgets. segment: contact segments. broadcast: e-mail broadcasts. automation: automations.

## Response `200`

Successful Response

- FolderList: One page of a list; `next_cursor` is null on the last page.
  - `items` FolderListItem[], required
    - `id` integer, required: 0 is General, where items outside any folder are
    - `name` string, required
    - `counts` FolderCounts, required
      - `total` integer, required: Live items in the folder
      - `active` integer, nullable: Of them, the ones that are on; null for items that are not turned on and off
  - `next_cursor` string, nullable: Always null: every folder comes in one page

## Other responses

- `400`: Unsupported GSC-Version
- `401`: Missing or invalid API key or access token
- `403`: Access denied
- `404`: Not found
- `422`: Validation failed
- `429`: Rate limited
- `503`: Temporarily unavailable; retry later

---

[API](https://skmtc.dev/getsitecontrol/apis/getsitecontrol-public-api.md) - [All operations](https://skmtc.dev/getsitecontrol/apis/getsitecontrol-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/getsitecontrol/apis/getsitecontrol-public-api/revisions/084fcad80e75?raw)
