# IconLibrary

> Type in domain **Libraries**

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

Implements: `Node`, `Library`

## 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`: `LibraryRootFolder!` — Browse the `Library` `SubFolderItems` and `AssetItems`.
- `collaborators`: `LibraryCollaborators` — `Library` collaborators.
- `currentUserPermissions`: `LibraryUserPermissions!` — `Library` permissions of the current `User`.
- `customMetadataProperties`: `[CustomMetadataProperty!]!` — Retrieve list of all `CustomMetadataProperty` items belonging to `Library`.
- `collections` (`limit`: `Int`, `page`: `Int`): `CollectionItems!` — `Library` `Collection` items list.
- `assetsByExternalId` (`externalId`: `ID!`, `limit`: `Int`, `cursor`: `String`): `LibraryAssetsByExternalIdResult!` — Fetch `Assets` in this `Library` by their externalId. Requires edit access to the `Library`.
- `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.

## Reach via

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

### `library`

```graphql
query Library {
  library(id: "…") {
    ... on IconLibrary {
      __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 }
        }
      }
      collections {
        total
        page
        limit
        hasNextPage
        items {
          name
          id
          assets {
            total
            page
            limit
            hasNextPage
            items { id }
          }
          currentUserPermissions { canAddAssets }
        }
      }
      color {
        alpha
        blue
        green
        red
      }
      currentUserPermissions {
        canCreateAssets
        canCreateCollections
        canViewCollaborators
      }
      customMetadataProperties {
        name
        id
        createdAt
        defaultValue
        forbiddenDependeePropertyIds
        helpText
        creator {
          __typename
          name
          id
        }
        dependency {
          __typename
          propertyId
          type
          ... on CustomMetadataPropertySelectValueTypeDependencyTypeEquals {
            propertyOptionId
          }
          ... on CustomMetadataPropertySelectValueTypeDependencyTypeOneOf {
            propertyOptionIds
          }
        }
        modifier {
          __typename
          name
          id
        }
        permissions {
          basic { permissionLevel }
          custom { permissionLevel }
        }
        type {
          __typename
          name
          ... on CustomMetadataPropertyTypeCatalog {
            allowedLinkedColumnIds
            allowMultiSelect
          }
        }
      }
      id
      licenses {
        title
        id
        addByDefault
        license
        requireConsensus
      }
      name
      workflow {
        id
        statuses {
          name
          id
          enterRules
          assignedUsers { id }
          checklistPresets { id }
        }
      }
    }
  }
}
```

Raw: [`Library-IconLibrary.sdl`](../examples/Library-IconLibrary.sdl)

### `brand › libraries`

```graphql
query BrandLibraries {
  brand(id: "…") {
    libraries(limit: 25, page: 1) {
      items {
        ... on IconLibrary {
          __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 }
            }
          }
          collections {
            total
            page
            limit
            hasNextPage
            items {
              name
              id
              assets {
                total
                page
                limit
                hasNextPage
                items { id }
              }
              currentUserPermissions { canAddAssets }
            }
          }
          color {
            alpha
            blue
            green
            red
          }
          currentUserPermissions {
            canCreateAssets
            canCreateCollections
            canViewCollaborators
          }
          customMetadataProperties {
            name
            id
            createdAt
            defaultValue
            forbiddenDependeePropertyIds
            helpText
            creator {
              __typename
              name
              id
            }
            dependency {
              __typename
              propertyId
              type
              ... on CustomMetadataPropertySelectValueTypeDependencyTypeEquals {
                propertyOptionId
              }
              ... on CustomMetadataPropertySelectValueTypeDependencyTypeOneOf {
                propertyOptionIds
              }
            }
            modifier {
              __typename
              name
              id
            }
            permissions {
              basic { permissionLevel }
              custom { permissionLevel }
            }
            type {
              __typename
              name
              ... on CustomMetadataPropertyTypeCatalog {
                allowedLinkedColumnIds
                allowMultiSelect
              }
            }
          }
          id
          licenses {
            title
            id
            addByDefault
            license
            requireConsensus
          }
          name
          workflow {
            id
            statuses {
              name
              id
              enterRules
              assignedUsers { id }
              checklistPresets { id }
            }
          }
        }
      }
    }
  }
}
```

Raw: [`BrandLibraries-IconLibrary.sdl`](../examples/BrandLibraries-IconLibrary.sdl)

### `webhooks › project`

```graphql
query WebhooksProject {
  webhooks(limit: 25, page: 1) {
    items {
      ... on ProjectWebhook {
        project {
          ... on IconLibrary {
            __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 }
              }
            }
            collections {
              total
              page
              limit
              hasNextPage
              items {
                name
                id
                assets {
                  total
                  page
                  limit
                  hasNextPage
                  items { id }
                }
                currentUserPermissions { canAddAssets }
              }
            }
            color {
              alpha
              blue
              green
              red
            }
            currentUserPermissions {
              canCreateAssets
              canCreateCollections
              canViewCollaborators
            }
            customMetadataProperties {
              name
              id
              createdAt
              defaultValue
              forbiddenDependeePropertyIds
              helpText
              creator {
                __typename
                name
                id
              }
              dependency {
                __typename
                propertyId
                type
                ... on CustomMetadataPropertySelectValueTypeDependencyTypeEquals {
                  propertyOptionId
                }
                ... on CustomMetadataPropertySelectValueTypeDependencyTypeOneOf {
                  propertyOptionIds
                }
              }
              modifier {
                __typename
                name
                id
              }
              permissions {
                basic { permissionLevel }
                custom { permissionLevel }
              }
              type {
                __typename
                name
                ... on CustomMetadataPropertyTypeCatalog {
                  allowedLinkedColumnIds
                  allowMultiSelect
                }
              }
            }
            id
            licenses {
              title
              id
              addByDefault
              license
              requireConsensus
            }
            name
            workflow {
              id
              statuses {
                name
                id
                enterRules
                assignedUsers { id }
                checklistPresets { id }
              }
            }
          }
        }
      }
    }
  }
}
```

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

### `brands › libraries`

```graphql
query BrandsLibraries {
  brands {
    libraries(limit: 25, page: 1) {
      items {
        ... on IconLibrary {
          __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 }
            }
          }
          collections {
            total
            page
            limit
            hasNextPage
            items {
              name
              id
              assets {
                total
                page
                limit
                hasNextPage
                items { id }
              }
              currentUserPermissions { canAddAssets }
            }
          }
          color {
            alpha
            blue
            green
            red
          }
          currentUserPermissions {
            canCreateAssets
            canCreateCollections
            canViewCollaborators
          }
          customMetadataProperties {
            name
            id
            createdAt
            defaultValue
            forbiddenDependeePropertyIds
            helpText
            creator {
              __typename
              name
              id
            }
            dependency {
              __typename
              propertyId
              type
              ... on CustomMetadataPropertySelectValueTypeDependencyTypeEquals {
                propertyOptionId
              }
              ... on CustomMetadataPropertySelectValueTypeDependencyTypeOneOf {
                propertyOptionIds
              }
            }
            modifier {
              __typename
              name
              id
            }
            permissions {
              basic { permissionLevel }
              custom { permissionLevel }
            }
            type {
              __typename
              name
              ... on CustomMetadataPropertyTypeCatalog {
                allowedLinkedColumnIds
                allowMultiSelect
              }
            }
          }
          id
          licenses {
            title
            id
            addByDefault
            license
            requireConsensus
          }
          name
          workflow {
            id
            statuses {
              name
              id
              enterRules
              assignedUsers { id }
              checklistPresets { id }
            }
          }
        }
      }
    }
  }
}
```

Raw: [`BrandsLibraries-IconLibrary.sdl`](../examples/BrandsLibraries-IconLibrary.sdl)