Folders

List folders

List all folders accessible to the authenticated user, returned as a flat list with full paths.

Pass scope to filter to one of the three top-level meta-collections shown in the GC AI UI:

my-files: folders rooted in the user's personal "My Files" tree
shared-with-me: folders explicitly shared with the user by other users
organization: folders rooted in the organization's "Organization Files" tree

Filtering by scope requires a user-scoped API key (u:gcai_...).

get/folders

Request

Base URL
https://app.gc.ai/api/external/v1
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/gc-ai/apis/gc-ai-external-api/docs/folders/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

limitinteger

Max items to return (default 100, max 500)

offsetinteger nullable

Number of items to skip (default 0)

qstring

Case-insensitive substring search on folder name or description. System-owned collection types (my-files, org-files, etc.) are excluded from results. Composes with scope.

Example:contracts

scope'my-files' | 'shared-with-me' | 'organization'

Filter folders to a single meta-collection. Requires a user-scoped API key.

Example:my-files

Response

List of folders

Example response

{
  "folders": [
    {
      "path": "/My Files/Contracts"
    }
  ]
}

Changes

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