# Folder

> Interface in domain **Folders**

- HTML: [Folder.html](Folder.html)
- Raw SDL: [Folder.sdl](Folder.sdl)
- Covered by: [llms.txt](../llms.txt)

`FolderInterface` for `Folder` returnable types.

## Fields

- `id`: `ID!` — `Folder` Id.
- `name`: `String!` — `Folder` name.
- `creator`: `User!` — The `User` who created the `Folder`.
- `createdAt`: `DateTime!` — `DateTime` of the `Folder` creation.
- `modifier`: `User` — The `User` who last modified the `Folder`.
- `modifiedAt`: `DateTime` — `DateTime` of the last `Folder` modification.
- `breadcrumbs`: `[Breadcrumb!]!` — A list of `Breadcrumb` items representing the parent folders structure for the current `SubFolder`.
- `subFolders` (`limit`: `Int`, `page`: `Int`): `SubFolderItems!` _(deprecated)_ — The `SubFolderItems` of the current `Library`/`Workspace`/`SubFolder`.
- `folders` (`limit`: `Int`, `page`: `Int`): `FolderItems!` — The `FolderItems` of the current `Library`/`Workspace`/`Folder`.
- `assets` (`limit`: `Int`, `page`: `Int`, `query`: `FolderAssetQueryInput`): `AssetItems!` — The `AssetItems` in the current `Library`/`Workspace`/`Folder`.

## Related mutations

- [`createFolder`](../mutation/createFolder.md)
- [`deleteFolders`](../mutation/deleteFolders.md)
- [`moveFolders`](../mutation/moveFolders.md)
- [`updateFolder`](../mutation/updateFolder.md)

## Reach via

Example queries that can return this type from the root `Query`.

### `library › browse › folders`

```graphql
query LibraryBrowseFolders {
  library(id: "…") {
    browse {
      folders(limit: 25, page: 1) {
        items {
          __typename
          assets {
            total
            page
            limit
            hasNextPage
            items {
              __typename
              title
              id
              alternativeText
              author
              attachments { id }
              availability { from }
              ... on Audio {
                previewUrl
                thumbnailUrl
                filename
                downloadUrl
              }
              ... on Document {
                previewUrl
                thumbnailUrl
                filename
                downloadUrl
              }
              ... on EmbeddedContent {
                previewUrl
                thumbnailUrl
                isDecorative
              }
              ... on File {
                previewUrl
                thumbnailUrl
                filename
                downloadUrl
              }
              ... on Image {
                previewUrl
                thumbnailUrl
                filename
                downloadUrl
              }
              ... on Video {
                previewUrl
                thumbnailUrl
                filename
                bitrate
              }
            }
          }
          breadcrumbs {
            name
            id
          }
          createdAt
          creator {
            __typename
            name
            id
          }
          folders {
            total
            page
            limit
            hasNextPage
            items {
              __typename
              name
              id
              createdAt
              modifiedAt
              assets {
                total
                page
                limit
                hasNextPage
                items { id }
              }
              breadcrumbs { id }
            }
          }
          id
          modifiedAt
          modifier {
            __typename
            name
            id
          }
          name
        }
      }
    }
  }
}
```

Raw: [`LibraryBrowseFolders.sdl`](../examples/LibraryBrowseFolders.sdl)

### `workspaceProject › browse › folders`

```graphql
query WorkspaceProjectBrowseFolders {
  workspaceProject(id: "…") {
    browse {
      folders(limit: 25, page: 1) {
        items {
          __typename
          assets {
            total
            page
            limit
            hasNextPage
            items {
              __typename
              title
              id
              alternativeText
              author
              attachments { id }
              availability { from }
              ... on Audio {
                previewUrl
                thumbnailUrl
                filename
                downloadUrl
              }
              ... on Document {
                previewUrl
                thumbnailUrl
                filename
                downloadUrl
              }
              ... on EmbeddedContent {
                previewUrl
                thumbnailUrl
                isDecorative
              }
              ... on File {
                previewUrl
                thumbnailUrl
                filename
                downloadUrl
              }
              ... on Image {
                previewUrl
                thumbnailUrl
                filename
                downloadUrl
              }
              ... on Video {
                previewUrl
                thumbnailUrl
                filename
                bitrate
              }
            }
          }
          breadcrumbs {
            name
            id
          }
          createdAt
          creator {
            __typename
            name
            id
          }
          folders {
            total
            page
            limit
            hasNextPage
            items {
              __typename
              name
              id
              createdAt
              modifiedAt
              assets {
                total
                page
                limit
                hasNextPage
                items { id }
              }
              breadcrumbs { id }
            }
          }
          id
          modifiedAt
          modifier {
            __typename
            name
            id
          }
          name
        }
      }
    }
  }
}
```

Raw: [`WorkspaceProjectBrowseFolders.sdl`](../examples/WorkspaceProjectBrowseFolders.sdl)

### `brand › libraries › browse › folders`

```graphql
query BrandLibrariesBrowseFolders {
  brand(id: "…") {
    libraries(limit: 25, page: 1) {
      items {
        browse {
          folders(limit: 25, page: 1) {
            items {
              __typename
              assets {
                total
                page
                limit
                hasNextPage
                items {
                  __typename
                  title
                  id
                  alternativeText
                  author
                  attachments { id }
                  availability { from }
                  ... on Audio {
                    previewUrl
                    thumbnailUrl
                    filename
                    downloadUrl
                  }
                  ... on Document {
                    previewUrl
                    thumbnailUrl
                    filename
                    downloadUrl
                  }
                  ... on EmbeddedContent {
                    previewUrl
                    thumbnailUrl
                    isDecorative
                  }
                  ... on File {
                    previewUrl
                    thumbnailUrl
                    filename
                    downloadUrl
                  }
                  ... on Image {
                    previewUrl
                    thumbnailUrl
                    filename
                    downloadUrl
                  }
                  ... on Video {
                    previewUrl
                    thumbnailUrl
                    filename
                    bitrate
                  }
                }
              }
              breadcrumbs {
                name
                id
              }
              createdAt
              creator {
                __typename
                name
                id
              }
              folders {
                total
                page
                limit
                hasNextPage
                items {
                  __typename
                  name
                  id
                  createdAt
                  modifiedAt
                  assets {
                    total
                    page
                    limit
                    hasNextPage
                    items { id }
                  }
                  breadcrumbs { id }
                }
              }
              id
              modifiedAt
              modifier {
                __typename
                name
                id
              }
              name
            }
          }
        }
      }
    }
  }
}
```

Raw: [`BrandLibrariesBrowseFolders.sdl`](../examples/BrandLibrariesBrowseFolders.sdl)

### `brands › libraries › browse › folders`

```graphql
query BrandsLibrariesBrowseFolders {
  brands {
    libraries(limit: 25, page: 1) {
      items {
        browse {
          folders(limit: 25, page: 1) {
            items {
              __typename
              assets {
                total
                page
                limit
                hasNextPage
                items {
                  __typename
                  title
                  id
                  alternativeText
                  author
                  attachments { id }
                  availability { from }
                  ... on Audio {
                    previewUrl
                    thumbnailUrl
                    filename
                    downloadUrl
                  }
                  ... on Document {
                    previewUrl
                    thumbnailUrl
                    filename
                    downloadUrl
                  }
                  ... on EmbeddedContent {
                    previewUrl
                    thumbnailUrl
                    isDecorative
                  }
                  ... on File {
                    previewUrl
                    thumbnailUrl
                    filename
                    downloadUrl
                  }
                  ... on Image {
                    previewUrl
                    thumbnailUrl
                    filename
                    downloadUrl
                  }
                  ... on Video {
                    previewUrl
                    thumbnailUrl
                    filename
                    bitrate
                  }
                }
              }
              breadcrumbs {
                name
                id
              }
              createdAt
              creator {
                __typename
                name
                id
              }
              folders {
                total
                page
                limit
                hasNextPage
                items {
                  __typename
                  name
                  id
                  createdAt
                  modifiedAt
                  assets {
                    total
                    page
                    limit
                    hasNextPage
                    items { id }
                  }
                  breadcrumbs { id }
                }
              }
              id
              modifiedAt
              modifier {
                __typename
                name
                id
              }
              name
            }
          }
        }
      }
    }
  }
}
```

Raw: [`BrandsLibrariesBrowseFolders.sdl`](../examples/BrandsLibrariesBrowseFolders.sdl)
