List folders

List folders in your tenant.

Returns: Folders that match the search filter.

POST /api/v1/product/list

Authorization

• Bearer {token} accessible from Authorization - Bearer token or systematically via Client Credentials.

  • The request headers should include a key for Authorization with the value Bearer {token}.

• API key created from Authorization - API keys. The API key groups must contain User groups that are also assigned to Permissions - Features permissions Spark.FolderList.json or Spark.AllEncompassingProxy.json.

  • The request headers should include the keys x-synthetic-key and x-tenant-name with the values of the API key and tenant name respectively.

Request body

Content-Type: application/json

Key	Value
page	Page number of the list to get.
pageSize	Number of records per page.
sort	String defining the sort order. Example: -updated
search	Array of search filter objects. Search filter objects can include: field Name of the field to filter. value Value of the field to filter. operator Applies to numeric properties. Example 1: {"field": "name", "name": "myfoldername" Example 2: {"field": "isstarred", "isstarred", "true"}

Sample request

{
    "page":1,
    "pageSize":10,
    "sort":"-updated",
    "search":
        [
            {
                "field":"name",
                "value":"Simon Testing"
            }
        ]
}

Sample response

HTTP 200 OK Content-Type: application/json

{
    "count": 1,
    "next": null,
    "previous": null,
    "message": null,
    "data": [
        {
            "id": "88018b91-6c91-4309-a70b-5bcacfc8a724",
            "name": "myfolder",
            "status": "Design",
            "category": "Other",
            "description": "myfolderdescription",
            "coverImagePath": "41f7dd49-8582-4f00-945c-b49242a52b0d.jpeg",
            "createdAt": "2020-12-18T02:04:03.610588Z",
            "createdBy": "0ec91ce3-52d2-41df-abf8-60b038cd7670",
            "lastModifiedDate": "2025-12-02T00:59:39.178648Z",
            "isStarred": true,
            "startDate": "2020-12-18T00:00:00Z",
            "launchDate": "2021-03-18T00:00:00Z",
            "totalServiceCount": 3
        }
    ],
    "errorCode": null,
    "status": "Success"
}