Get a document folder by ID or custom folder ID

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The folder identifier. Can be either the numeric Customerly folder ID (e.g., '10') or your custom_folder_id prefixed with 'cid:' (e.g., 'cid:fld_manuals')

Responses

401

Authentication required

403

Permission denied

404

Document folder not found

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json