Retrieves a folder using either the internal Customerly folder ID or your custom identifier.
Folder Identification
1. Customerly Folder ID (numeric):
- Example:
GET /documents/folders/10
2. Custom Folder ID (prefixed with cid:):
- Example:
GET /documents/folders/cid:fld_manuals
Content Visibility
The response includes contact_segment_visibilities and company_segment_visibilities — arrays of
{segment_id, is_inherited} objects that define which contact/company segments can access this folder
and its documents inside Aura (the AI assistant).
Visibility rules set on a folder are automatically inherited by all documents inside it that do
not have their own explicit visibility rules. Only contacts and companies belonging to the specified
segments will be able to see and interact with this content through Aura.
- An empty array means no restrictions apply (visible to everyone).
Use PUT /documents/folders to update visibilities.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
401Authentication required
403Permission denied
404Document folder not found