This document is generated by Aladia.

Aladia API

Search Folders

Testing

GET

/spaces/{spaceId}/folders/search

This endpoint filters the folders belonging to the space.

Expected query parameters:

query: the term used to search and filter the folders belonging to the specified Space

Expected path parameters:

spaceId: Space Id from which the list of folders will be returned

Returns:
subfolders array with eventual subfolders matching the query and their data

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.aladia.io/v2/spaces/661666becf024c47c39a2170/folders/search?query=ruby crystal&query=&parent=661666becf024c47c39a2183&limit=50&next=&prev=&sortBy=&sortDirection=asc' \
--header 'apikey: '

Response Example

200 - Success

{
  "data": [
    {
      "subFolders": [],
      "id": "6656da973c9924e4dcc7f7ce",
      "name": "Vue.js courses",
      "parent": "6655b3f156af8d342897a004",
      "items": 0,
      "columns": [],
      "courses": [
        {
          "id": "6655adf6efc95eeb791f8e65",
          "owner": {
            "id": "6655b15980a4c5ad3181e5e0",
            "type": "profile"
          },
          "title": "Python",
          "description": "Python course description",
          "categories": [
            {
              "id": "66387c31af7ac7a0556e428e",
              "name": "Incredible Bronze Mouse",
              "parentId": "bdb1f09d17b873c57c8fe108",
              "image": "https://loremflickr.com/640/480",
              "proposeduserId": "42ac7a5e223f6e6eee61e8fc",
              "status": "active"
            }
          ],
          "subCategories": [],
          "spaceId": "2541860fe27847fa57ffb16f",
          "chapters": [],
          "thumbnail": "https://storage.googleapis.com/66542ff93a712c2dfba90931/66549ffdd89a42d9021b9cfa?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=bucket%40backend-test-aladia.iam.gserviceaccount.com%2F20240529%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20240529T112623Z&X-Goog-Expires=3600&X-Goog-SignedHeaders=host&X-Goog-Signature=68a7e9172a72f153ca1136501f7c4cd84c78932acbc865fe0aed8204a1004eb72b5eee03320d508fd301b84d0c09dc7594212fe847f1276fa3ae7682113167c9ccf2b3151a39dfa406798df64a36c32c3cc2a95df204a95fecdbdcfcc31f76d5a6bf25146c985e591a7318b44f512a7757360c3ee758fdc6e692d40161a770b471cb3796a0493bfc93512ff0d64ba332f4d2bd2fccaed9fda6ee48b5d2931de7d84ce639dfb2286a3ec77fbc61cc567ad530600d07368a116a63af55ac3f4e8fde52bfbbd8549718825df72503d9ab10bd1eaf45a5f0d87a1349f25d4bdbebd91ea6dce2d6776634e3500b1cd598a923117d940e605bd0d3a355f62958ef0558",
          "trailer": "https://storage.googleapis.com/66542ff93a712c2dfba90931/6654a000d89a42d9021b9cfd?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=bucket%40backend-test-aladia.iam.gserviceaccount.com%2F20240529%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20240529T112623Z&X-Goog-Expires=3600&X-Goog-SignedHeaders=host&X-Goog-Signature=4eca761c8f1702f46f3b09269d0c1c0174031c5ad3ebaed80f6a500238192ab70b24bf80478cf0b3315cc752e16b99055752ffbd1e6b0cbcc24c89d8f5f949eb7087934f09c744dc615018a0457afa508a8241b2d88180346e4024efa189e98bc37183a63516250d815717eb93c4b9709d49bfa474eb52797e0a1332c0eccb77237fb94589415193979ce00ff2ff6a428bd110f8f8f3f8fb797e9df9ea9b108f012f102a637593bb4669285dcd91cd72a03e8ac177728638ee55ab9d151cda76c4c82cac4181e276dca59465e3c95a17e5f7a83a07a5be837e8906226a20ef7932cf76e1cbf19d9408a83574a033e5cc5dfbc03a28889f9a7c09c746dd1b8740",
          "trailerImage": "https://storage.googleapis.com/66542ff93a712c2dfba90931/6654a002d89a42d9021b9d00?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=bucket%40backend-test-aladia.iam.gserviceaccount.com%2F20240529%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20240529T112624Z&X-Goog-Expires=3600&X-Goog-SignedHeaders=host&X-Goog-Signature=3b1d330fbfe8d2c8bd69617358b06bc669d5576bbf4ab6f63422b3bb76cbd1ab74c275f6d671fe83c05e8fbcdf5396214412bc7ac67502c68c04d45bd6670bb05cdd942d56270df8a88ccc84cd49c3b615811fade27cc7eb6786bc84753c1ba9ef723f6073af2dc3f5838c55ad29c00dcb802be4ab20113e982acc78d1cd44f21aa567f97863dec1e7576914fce617f9cad5ff76a64e549080c0fdd6b6a090cc9c472dac038f47776957d7c35864cdf66e05320c82d271bbf5099379292de3afd4cac3134238ee7aa0619b9d4ac551049920876ca55cd3b876c2b0c76ca7757ae1b802a5b70d1050b77078bc3105fc8db7ae64836633cb4855e13ee86c2c1404",
          "duration": 30243,
          "requirements": [
            "Basic Computer Skills"
          ],
          "objectives": [
            "Master the fundamentals of writing Python scripts",
            "Use Python to read and write files"
          ],
          "members": [
            {
              "profileId": "663c7dcdb541c96d6762922b",
              "role": "User"
            },
            {
              "profileId": "6638775e2d31cb049e45e326",
              "role": "Admin"
            },
            {
              "profileId": "663cc8e5ddff3badefa9ba34",
              "role": "User"
            }
          ],
          "earnings": 71072,
          "numberOf": {},
          "type": "onDemand",
          "visibility": "public",
          "status": "ongoing",
          "dates": {
            "startDate": "2022-07-06T01:16:03.423Z",
            "endDate": "2018-03-31T22:42:40.593Z"
          },
          "reviews": {
            "totalReviews": 2,
            "globalRating": 4,
            "ratings": [
              {
                "star": 1,
                "count": 0,
                "percentage": 0
              },
              {
                "star": 2,
                "count": 0,
                "percentage": 0
              },
              {
                "star": 3,
                "count": 1,
                "percentage": 50
              },
              {
                "star": 4,
                "count": 0,
                "percentage": 0
              },
              {
                "star": 5,
                "count": 1,
                "percentage": 50
              }
            ]
          },
          "completion": {
            "percentage": 0,
            "chapters": []
          },
          "createdBy": "66542ff93a712c2dfba90931",
          "updatedBy": "66542ff93a712c2dfba90931",
          "roomId": "cee4da54b3f960c5f0eca95a",
          "calendarId": "5dec33e2ef1428b962c4125c",
          "productId": "ee9a871ea1dd7b7ae280028c",
          "createdAt": "2024-05-28T10:12:06.362Z",
          "updatedAt": "2024-05-29T10:09:54.723Z"
        }
      ]
    }
  ],
  "cursor": {
    "next": "6656da973c9924e4dcc7f7ce",
    "prev": null,
    "totalItems": 3
  }
}

Request

Path Params

spaceId

string

required

The Space Id

Example:

661666becf024c47c39a2170

Query Params

query

string

required

The search query string.

Example:

ruby crystal

parent

string

optional

(Optional) Id from a parent folder, if you do not want to search on the space's root folder

Example:

661666becf024c47c39a2183

limit

integer

optional

Number of documents per page in the response

Default:

string

optional

Next token cursor, to navigate towards the next page

string

optional

Previous token cursor, to navigate towards the previous page

sortBy

string

optional

Optional field to be used as a sorting reference

sortDirection

enum<string>

optional

Set the results in ascending (asc) or descending (desc) direction

Allowed values:

ascdesc

Default:

asc

Header Params

apikey

string

optional

Example:

Responses

🟢200Success

application/json

Body

object {0}

🟠404Record Not Found

Modified at 2025-04-10 05:17:26

List All Folders

Create a Folder