Folders

Get a folder

Retrieve a single folder by ID.

get/folders/{id}

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/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring uuid required

The folder ID

Response

Folder details

idstring uuid required

Unique folder identifier

namestring required

Folder name

descriptionstring nullable required

Folder description, or null if unset

pathstring required

Path through ancestors visible to the requester. Inaccessible ancestors are skipped, so this may not reflect absolute depth. Use parent_folder_id to traverse hierarchy.

parent_folder_idstring uuid nullable required

Parent folder ID, or null for root

folder_typestring required

Folder type (custom, my-files, etc.)

created_atstring required

ISO 8601 creation timestamp

Example response

{
  "path": "/My Files/Contracts"
}

Changes

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