Get folders

GET
/api/v2/hubfolders

Gets folders with optional exclusion and optional pagination/filtering. Returns a list of folders.

Authorization

Bearer
AuthorizationBearer <token>

JWT Authorization header using the Bearer scheme. Example: 'Bearer {token}'

In: header

Query Parameters

sort_by?string

Sort by field name (optional). Available fields: "Name", "ParentUrl"

name?string

Folder name used for filtering. Optional filter operators can be applied to refine the search:

  • equal (default)
  • contains
  • startswith
  • endswith
page?integer

Page number (1-based). Default is 1. Ignored when get_all = true.

Formatint32
Range1 <= value <= 2147483647
page_size?integer

Number of items per page. Default is 10. Maximum is 100. Ignored when get_all = true.

Formatint32
Range1 <= value <= 50
get_all?boolean

When true, pagination is disabled and all items are returned.

sort_direction?string

Sort direction: "asc" or "desc". Default is "asc" (optional)

exceptFolderId?string

Optional folder ID to exclude from the results.

Formatuuid
exceptRoot?boolean

If true, excludes the root folder from the results.

Defaultfalse

Response Body

application/json

application/json

curl -X GET "https://example.com/api/v2/hubfolders"
{  "isSuccess": true,  "error": {},  "errorDetails": "string",  "message": "string",  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",      "name": "string",      "parentUrl": "string",      "location": "string"    }  ],  "resultInfo": {    "page": 0,    "perPage": 0,    "totalCount": 0,    "totalPages": 0,    "hasPreviousPage": true,    "hasNextPage": true  }}