List Folders

GEThttps://api.konpro.ai/v1/folders

Retrieve a list of folders within your account, with support for optional filters and pagination.

Request History

Log in to see full request history

TIMESTATUSUSER AGENT
Make a request to see history.

0 Requests This Month

cURL Request

shell
curl --request GET \
--url "https://api.konpro.ai/v1/folders?limit=50&is_trash=false" \
--header "accept: application/json" \
--header "x-api-key: <your-api-key>"

Query Parameters

ParameterTypeDescription
limitintegerNumber of folders to return per request
parent_idstringFilter folders by their parent folder ID
name_filterstringFilter folders by matching names
is_trashbooleanFilter to include only trashed (true) or non-trashed (false) folders
tokenstringPagination token for retrieving the next set of results

Response

Response Structure

FieldTypeDescription
foldersarray[object]Array of folder objects
tokenstringPagination token for next page
has_morebooleanWhether more results are available

Sample Response

json
{
  "folders": [
    {
      "id": "folder_123",
      "name": "My Projects",
      "parent_id": null,
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z",
      "is_trash": false
    },
    {
      "id": "folder_456",
      "name": "Archive",
      "parent_id": "folder_123",
      "created_at": "2024-01-14T09:15:00Z",
      "updated_at": "2024-01-14T09:15:00Z",
      "is_trash": false
    }
  ],
  "token": "eyJ0b2tlbiI6InBhZ2luYXRpb24ifQ",
  "has_more": false
}

Notes

  • Requires API authentication.
  • Returns folders owned by the authenticated user.
  • Supports hierarchical folder structure with parent_id.
  • Use pagination tokens to retrieve additional results.
  • Filter by parent_id to get subfolders.
  • Use name_filter for partial name matching.
  • Set is_trash=true to list deleted folders.
  • Refer to Error Responses for error information.

Example Usage

Shell
curl --request GET \
--url "https://api.konpro.ai/v1/folders?limit=50&is_trash=false" \
--header "accept: application/json" \
--header "x-api-key: <your-api-key>"

LANGUAGE

CREDENTIALS

HEADER

RESPONSE

Examples

Choose an example:

application/json
200 - Success
401 - Unauthorized