folder

List guides within a folder

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

get/folder/guide

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).

guideStatus'draft' | 'published' | 'unpublished'

Filter guides by their publication status.

namesstring[]

Filter items where the name contains one of these strings.

[
  "Folder name"
]

tagsstring[]

Filter items that have at least one of these tags.

[
  "Tag name"
]

updatedDateFromstring date

Example:2025-09-01

Filter content updated on or after this date (inclusive). Format: YYYY-MM-DD.

updatedDateTostring date

Example:2025-10-01

Filter content updated before this date (exclusive). Format: YYYY-MM-DD.

publishedDateFromstring date

Example:2025-09-01

Filter content published on or after this date (inclusive). Format: YYYY-MM-DD.

publishedDateTostring date

Example:2025-10-01

Filter content published before this date (exclusive). Format: YYYY-MM-DD.

recursiveboolean

If true, includes items from the specified folder and all its subfolders. If false, returns only direct children.

Response

Guide list retrieved successfully.

itemsCounterinteger

Total number of items available.

existsNextboolean

True if more pages of results are available.

Example response

{
  "items": [
    {
      "entityId": "ioTkq4uNhy",
      "entityName": "Example guide name",
      "entityStatus": "draft",
      "entityLanguages": [
        "en",
        "pl",
        "ru",
        "ar",
        "et"
      ],
      "entityFolder": {
        "id": 33836,
        "name": "Cypress Visual Smoke Tests"
      }
    }
  ]
}

Changes

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