Folders

Retrieve list of objects under specified folder

Changed on Sep 9, 2026

Retrieve a list of objects under a specified folder, including child folders, segments, batch segments, predictive scoring models, funnels, Profile API tokens and Journeys.

get/entities/by-folder/{folderId}

Request

Base URL
https://api-cdp.treasuredata.com
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/treasure/apis/cdp-api/docs/entities/by-folder/:folderId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

folderIdinteger required

Segment Folder ID

Query parameters

depthinteger required

Depth of retrieved folders

with_ruleboolean

Set false to ignore the segment rule

Response

Returns a list of entities under the specified folder. The specified folder is also included.

Changes

Sep 9, 2026c7cbe63450a3 Revision changes
- breaking
  added to the / response property oneOf list for the response status
- warning
  added the new periodic enum value to the /////////////// response property for the response status
- info
  added the optional property /////////////// to the response with the status
- info
  added the optional property /////////////// to the response with the status
- info
  added the optional property /////////////// to the response with the status
- info
  added the optional property /////////////// to the response with the status
Aug 14, 2026f5ae81d77da9 Revision changes
- info
  added the optional property /////////////// to the response with the status

Operation history