STstonly
folder

List folders

Retrieves a paginated list of folders residing in a specific folder.

get/folder

Request

  • Base URL
    https://public.stonly.com/api/v3
  • Auth
    HTTP basic

Query parameters

teamIdinteger

ID of the team to manage. Optional if the API key is associated with a single team.

folderIdinteger required
Example:123

The unique identifier of the folder.

pageinteger required

Page number for pagination (0-based index).

limitinteger required

Number of items to return per page (maximum 100).

namesstring[]

Filter items where the name contains one of these strings.

[
  "Folder name"
]

Response

Folder list retrieved successfully.

itemsCounterinteger

Total number of items available.

existsNextboolean

True if more pages of results are available.

Example response

{
  "items": [
    {
      "entityId": 1,
      "entityName": "Example folder name"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.