# Workspace

> Type in domain **Workspace**

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

Implements: `Node`

## Fields

- `id`: `ID!` — `Library`/`Workspace` Id.
- `name`: `String!` — `Library`/`Workspace` name.
- `color`: `RgbaColor` — `Library`/`Workspace` color.
- `assetCount`: `Int` _(deprecated)_ — Amount of `Assets` contained in the `Library`/`Workspace`.
- `assets` (`limit`: `Int`, `page`: `Int`, `query`: `AssetQueryInput`): `AssetItems!` — Search or list `Assets` in the `Library`/`Workspace`.
- `metadataFields`: `[MetadataField]` _(deprecated)_ — `Library`/`Workspace` `MetadataField` items list.
- `workflow`: `Workflow!` _(beta)_ — The `Workflow` belonging to the given `Library`/`Workspace`.
- `browse`: `WorkspaceRootFolder!` — Browse the `Workspace`'s `SubFolderItems` and `AssetItems`.
- `collaborators`: `WorkspaceCollaborators` — `Workspace` collaborators.
- `currentUserPermissions`: `WorkspaceUserPermissions!` — `Workspace` permissions of the current `User`.
- `isArchived`: `Boolean!` _(beta)_ — `Workspace` state.
- `customMetadata`: `[CustomMetadata!]!` — List of `CustomMetadataProperty` items and values associated to `Workspace`.
- `searchAssets` (`input`: `AssetSearchInput!`): `LibrarySearchAssetsResult!` — Search this `Library`'s/`Workspace`'s `Assets` with fully typed filters. Backed by our search index rather than the primary database — results are eventually consistent, so an asset just created, edited, or deleted can take a few minutes (up to around 10) to be reflected.
- `licenses`: `[License]` — `Library`/`Workspace` `License` items list.

## Related mutations

- [`createWorkspaceProject`](../mutation/createWorkspaceProject.md)

## Reach via

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

### `workspaceProject`

```graphql
query WorkspaceProject {
  workspaceProject(id: "…") {
    __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
        }
      }
    }
    browse {
      assets {
        total
        page
        limit
        hasNextPage
        items { id }
      }
      folders {
        total
        page
        limit
        hasNextPage
        items { id }
      }
    }
    collaborators {
      users {
        total
        page
        limit
        hasNextPage
        items { id }
      }
    }
    color {
      alpha
      blue
      green
      red
    }
    currentUserPermissions {
      canCreateAssets
      canViewCollaborators
    }
    customMetadata {
      __typename
      property {
        name
        id
        createdAt
        defaultValue
        creator { id }
        dependency { propertyId }
      }
      ... on CustomMetadataValue {
        value
      }
      ... on CustomMetadataValues {
        values
      }
    }
    id
    isArchived
    licenses {
      title
      id
      addByDefault
      license
      requireConsensus
    }
    name
    workflow {
      id
      statuses {
        name
        id
        enterRules
        assignedUsers { id }
        checklistPresets { id }
      }
    }
  }
}
```

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

### `brand › workspaceProjects`

```graphql
query BrandWorkspaceProjects {
  brand(id: "…") {
    workspaceProjects(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
            }
          }
        }
        browse {
          assets {
            total
            page
            limit
            hasNextPage
            items { id }
          }
          folders {
            total
            page
            limit
            hasNextPage
            items { id }
          }
        }
        collaborators {
          users {
            total
            page
            limit
            hasNextPage
            items { id }
          }
        }
        color {
          alpha
          blue
          green
          red
        }
        currentUserPermissions {
          canCreateAssets
          canViewCollaborators
        }
        customMetadata {
          __typename
          property {
            name
            id
            createdAt
            defaultValue
            creator { id }
            dependency { propertyId }
          }
          ... on CustomMetadataValue {
            value
          }
          ... on CustomMetadataValues {
            values
          }
        }
        id
        isArchived
        licenses {
          title
          id
          addByDefault
          license
          requireConsensus
        }
        name
        workflow {
          id
          statuses {
            name
            id
            enterRules
            assignedUsers { id }
            checklistPresets { id }
          }
        }
      }
    }
  }
}
```

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

### `webhooks › project`

```graphql
query WebhooksProject {
  webhooks(limit: 25, page: 1) {
    items {
      ... on ProjectWebhook {
        project {
          ... on Workspace {
            __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
                }
              }
            }
            browse {
              assets {
                total
                page
                limit
                hasNextPage
                items { id }
              }
              folders {
                total
                page
                limit
                hasNextPage
                items { id }
              }
            }
            collaborators {
              users {
                total
                page
                limit
                hasNextPage
                items { id }
              }
            }
            color {
              alpha
              blue
              green
              red
            }
            currentUserPermissions {
              canCreateAssets
              canViewCollaborators
            }
            customMetadata {
              __typename
              property {
                name
                id
                createdAt
                defaultValue
                creator { id }
                dependency { propertyId }
              }
              ... on CustomMetadataValue {
                value
              }
              ... on CustomMetadataValues {
                values
              }
            }
            id
            isArchived
            licenses {
              title
              id
              addByDefault
              license
              requireConsensus
            }
            name
            workflow {
              id
              statuses {
                name
                id
                enterRules
                assignedUsers { id }
                checklistPresets { id }
              }
            }
          }
        }
      }
    }
  }
}
```

Raw: [`WebhooksProject-Workspace.sdl`](../examples/WebhooksProject-Workspace.sdl)

### `brands › workspaceProjects`

```graphql
query BrandsWorkspaceProjects {
  brands {
    workspaceProjects(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
            }
          }
        }
        browse {
          assets {
            total
            page
            limit
            hasNextPage
            items { id }
          }
          folders {
            total
            page
            limit
            hasNextPage
            items { id }
          }
        }
        collaborators {
          users {
            total
            page
            limit
            hasNextPage
            items { id }
          }
        }
        color {
          alpha
          blue
          green
          red
        }
        currentUserPermissions {
          canCreateAssets
          canViewCollaborators
        }
        customMetadata {
          __typename
          property {
            name
            id
            createdAt
            defaultValue
            creator { id }
            dependency { propertyId }
          }
          ... on CustomMetadataValue {
            value
          }
          ... on CustomMetadataValues {
            values
          }
        }
        id
        isArchived
        licenses {
          title
          id
          addByDefault
          license
          requireConsensus
        }
        name
        workflow {
          id
          statuses {
            name
            id
            enterRules
            assignedUsers { id }
            checklistPresets { id }
          }
        }
      }
    }
  }
}
```

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