# Retrieve list of objects under specified folder

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

Endpoint: GET /entities/by-folder/{folderId}
Version: 1.0.0
Security: TdApikeyAuth

## Path parameters:

  - `folderId` (integer, required)
    Segment Folder ID

## Query parameters:

  - `depth` (integer, required)
    Depth of retrieved folders

  - `with_rule` (boolean)
    Set false to ignore the segment rule

## Response 200 fields (application/json):

  - `data` (array, required)

  - `data.id` (string, required)

  - `data.type` (string, required)
    Enum: "folder-segment"

  - `data.attributes` (object, required)

  - `data.attributes.audienceId` (string, required)
    ID of the parent audience. For composable folders this carries
the composable audience id; the complete-vs-composable
discriminator lives on the parent audience entity, not on the
folder.

  - `data.attributes.name` (string, required)

  - `data.attributes.description` (string, required)

  - `data.attributes.createdAt` (string, required)

  - `data.attributes.updatedAt` (string, required)

  - `data.attributes.enrichments` (object)

  - `data.attributes.rule` (object)

  - `data.attributes.permissions` (object, required)

  - `data.attributes.permissions.view` (boolean)

  - `data.attributes.permissions.edit` (boolean)

  - `data.relationships` (object, required)

  - `data.relationships.children` (object)

  - `data.relationships.children.data` (array)

  - `data.relationships.children.data.data` (object)

  - `data.relationships.children.data.data.id` (string, required)

  - `data.relationships.children.data.data.type` (string, required)
    Enum: "folder-segment", "segment-batch", "segment-realtime", "composable-segment", "funnel", "predictive-segment", "token", "journey"

  - `data.relationships.parentFolder` (object)

  - `data.relationships.parentFolder.data` (object)

  - `data.relationships.parentFolder.data.id` (string, required)

  - `data.relationships.parentFolder.data.type` (string, required)
    Enum: "folder-segment"

  - `data.relationships.createdBy` (object)

  - `data.relationships.createdBy.data` (object)

  - `data.relationships.createdBy.data.id` (string, required)

  - `data.relationships.createdBy.data.type` (string, required)
    Enum: "user"

  - `included` (array, required)

  - `included.id` (string, required)

  - `included.type` (string, required)
    Enum: "user"

  - `included.attributes` (object, required)

  - `included.attributes.tdUserId` (string, required)

  - `included.attributes.name` (string, required)