For the complete documentation index, see llms.txt. This page is also available as Markdown.

Asset groups

Complete reference for asset groups: group types with membership rules, groups, memberships, and history.

Asset groups allow organizing assets into logical collections for easier management and reporting.

Queries

assetGroupTypes

Lists asset group types for a workspace.

assetGroupTypes(
    workspaceId: ID!
    filter: CatalogItemFilter
    first: Int
    after: String
    last: Int
    before: String
    orderBy: CatalogItemOrder = { field: ORDER, direction: ASC }
  ): AssetGroupTypeConnection!

Arguments

Name
Type
Description

workspaceId

ID!

The workspace to retrieve asset group types for.

filter

CatalogItemFilter

Filtering options for the returned asset group types.

first

Int

The first n elements from the paginated list.

after

String

The elements that come after the specified cursor.

last

Int

The last n elements from the paginated list.

before

String

The elements that come before the specified cursor.

orderBy

CatalogItemOrder

The ordering options for the returned asset group types.

Input types:

CatalogItemFilter

Filtering options for catalog items.

Field
Type
Description

titleContains

String

Partial match on title (case-insensitive contains).

codes

[Code!]

Match any of these codes.

CatalogItemOrder

Ordering options for catalog items.

Field
Type
Description

field

The field to order by.

direction

The direction to order.

Output types:

AssetGroupTypeConnection

A paginated list of AssetGroupType items.

Implements: Connection

Field
Type
Description

edges

A list of edges.

nodes

A list of nodes in the connection (without edge metadata).

pageInfo

Information about the current page.

total

The total count of items matching the filter.


assetGroup (query)

Retrieves an asset group by its ID.

Arguments

Name
Type
Description

id

ID!

The ID of the asset group to retrieve.

Output types:

AssetGroup

A group of assets.

Implements: Node, Versioned, Titled

Field
Type
Description

id

ID!

A globally unique identifier. This ID is opaque and should not be parsed by clients.

version

Int!

The version number for optimistic locking. Incremented on each update. Can be provided in update/delete mutations to prevent lost updates. If omitted, the update proceeds without stale-read protection.

title

String!

The human-readable display name.

workspace

The workspace that owns this group.

type

The group type with membership constraints. Immutable after creation.

color

The color for UI display in hexadecimal format.

currentAssets

The assets currently in this group.

history

The full membership history for this group.


assetGroups

Lists asset groups for a workspace.

Arguments

Name
Type
Description

workspaceId

ID!

The workspace to retrieve asset groups for.

filter

AssetGroupFilter

Filtering options for the returned asset groups.

first

Int

The first n elements from the paginated list.

after

String

The elements that come after the specified cursor.

last

Int

The last n elements from the paginated list.

before

String

The elements that come before the specified cursor.

orderBy

AssetGroupOrder

The ordering options for the returned asset groups.

Input types:

AssetGroupFilter

Filtering options for asset groups.

Field
Type
Description

typeIds

[ID!]

Filter by group types (OR within field).

titleContains

String

Partial match on title (case-insensitive contains).

AssetGroupOrder

Ordering options for asset groups.

Field
Type
Description

field

The field to order by.

direction

The direction to order.

Output types:

AssetGroupConnection

A paginated list of AssetGroup items.

Implements: Connection

Field
Type
Description

edges

A list of edges.

nodes

A list of nodes in the connection (without edge metadata).

pageInfo

Information about the current page.

total

The total count of items matching the filter.


Mutations

assetGroupCreate

Creates a new asset group.

Arguments

Name
Type
Description

input

AssetGroupCreateInput!

The input fields for creating the asset group.

Input types:

AssetGroupCreateInput

Input for creating a new asset group.

Field
Type
Description

workspaceId

ID!

The workspace that will own the group.

typeId

ID

The group type ID. Immutable after creation.

title

String!

The group display name.

color

The color for UI display.

assetIds

[ID!]

Initial list of asset IDs to add to the group.

Output types:

AssetGroupPayload

The result of an asset group mutation.

Field
Type
Description

assetGroup

The created or updated asset group.

AssetGroup (entity)

A group of assets.

Implements: Node, Versioned, Titled

Field
Type
Description

id

ID!

A globally unique identifier. This ID is opaque and should not be parsed by clients.

version

Int!

The version number for optimistic locking. Incremented on each update. Can be provided in update/delete mutations to prevent lost updates. If omitted, the update proceeds without stale-read protection.

title

String!

The human-readable display name.

workspace

The workspace that owns this group.

type

The group type with membership constraints. Immutable after creation.

color

The color for UI display in hexadecimal format.

currentAssets

The assets currently in this group.

history

The full membership history for this group.


assetGroupUpdate

Updates an existing asset group.

Arguments

Name
Type
Description

input

AssetGroupUpdateInput!

The input fields for updating the asset group.

Input types:

AssetGroupUpdateInput

Input for updating an existing asset group.

Field
Type
Description

id

ID!

The asset group ID to update.

version

Int

The current version for optimistic locking. If omitted, auto-increments without conflict check.

title

String

The new display name.

color

The new color.

assetIds

[ID!]

Full replacement list of asset IDs in the group. If provided, replaces all current memberships.

Output types:

AssetGroupPayload

The result of an asset group mutation.

Field
Type
Description

assetGroup

The created or updated asset group.

AssetGroup (entity)

A group of assets.

Implements: Node, Versioned, Titled

Field
Type
Description

id

ID!

A globally unique identifier. This ID is opaque and should not be parsed by clients.

version

Int!

The version number for optimistic locking. Incremented on each update. Can be provided in update/delete mutations to prevent lost updates. If omitted, the update proceeds without stale-read protection.

title

String!

The human-readable display name.

workspace

The workspace that owns this group.

type

The group type with membership constraints. Immutable after creation.

color

The color for UI display in hexadecimal format.

currentAssets

The assets currently in this group.

history

The full membership history for this group.


assetGroupDelete

Deletes an asset group.

Arguments

Name
Type
Description

input

AssetGroupDeleteInput!

The input fields for deleting the asset group.

Input types:

AssetGroupDeleteInput

Input for deleting an asset group.

Field
Type
Description

id

ID!

The asset group ID to delete.

version

Int

The current version for optimistic locking. If omitted, auto-increments without conflict check.

Output types:

DeletePayload

The result of a delete mutation.

Field
Type
Description

deletedId

ID!

The ID of the deleted entity.


assetGroupItemsAdd

Adds assets to a group.

Arguments

Name
Type
Description

input

AssetGroupItemsAddInput!

The input fields for adding assets to the group.

Input types:

AssetGroupItemsAddInput

Input for adding assets to a group.

Field
Type
Description

groupId

ID!

The group ID.

assetIds

[ID!]!

The asset IDs to add.

Output types:

AssetGroupPayload

The result of an asset group mutation.

Field
Type
Description

assetGroup

The created or updated asset group.

AssetGroup (entity)

A group of assets.

Implements: Node, Versioned, Titled

Field
Type
Description

id

ID!

A globally unique identifier. This ID is opaque and should not be parsed by clients.

version

Int!

The version number for optimistic locking. Incremented on each update. Can be provided in update/delete mutations to prevent lost updates. If omitted, the update proceeds without stale-read protection.

title

String!

The human-readable display name.

workspace

The workspace that owns this group.

type

The group type with membership constraints. Immutable after creation.

color

The color for UI display in hexadecimal format.

currentAssets

The assets currently in this group.

history

The full membership history for this group.


assetGroupItemsRemove

Removes assets from a group.

Arguments

Name
Type
Description

input

AssetGroupItemsRemoveInput!

The input fields for removing assets from the group.

Input types:

AssetGroupItemsRemoveInput

Input for removing assets from a group.

Field
Type
Description

groupId

ID!

The group ID.

assetIds

[ID!]!

The asset IDs to remove.

Output types:

AssetGroupPayload

The result of an asset group mutation.

Field
Type
Description

assetGroup

The created or updated asset group.

AssetGroup (entity)

A group of assets.

Implements: Node, Versioned, Titled

Field
Type
Description

id

ID!

A globally unique identifier. This ID is opaque and should not be parsed by clients.

version

Int!

The version number for optimistic locking. Incremented on each update. Can be provided in update/delete mutations to prevent lost updates. If omitted, the update proceeds without stale-read protection.

title

String!

The human-readable display name.

workspace

The workspace that owns this group.

type

The group type with membership constraints. Immutable after creation.

color

The color for UI display in hexadecimal format.

currentAssets

The assets currently in this group.

history

The full membership history for this group.


assetGroupTypeCreate

Creates a new asset group type.

Arguments

Name
Type
Description

input

AssetGroupTypeCreateInput!

The input fields for creating the asset group type.

Input types:

AssetGroupTypeCreateInput

Input for creating an asset group type.

Field
Type
Description

workspaceId

ID!

The workspace that will own the item.

code

The machine-readable code. Auto-generated from title if omitted.

title

String!

The display name.

order

Int

The display order. Auto-calculated as last position if omitted.

allowedAssetTypes

The allowed asset types with optional limits.

meta

The display properties.

AssetGroupTypeConstraintInput

Input for a constraint defining allowed asset types in an asset group type.

Field
Type
Description

assetTypeId

ID!

The asset type ID.

maxItems

Int

The maximum assets of this type. Null means unlimited.

CatalogItemMetaInput

Display properties for catalog items.

Field
Type
Description

description

String

The description.

hidden

Boolean

Whether the item is hidden from regular UI lists.

Output types:

AssetGroupTypePayload

The result of an asset group type mutation.

Field
Type
Description

assetGroupType

The created or updated asset group type.

AssetGroupType (entity)

A type for asset groups with membership constraints.

Implements: CatalogItem, Node, Versioned, Titled

Field
Type
Description

id

ID!

A globally unique identifier.

version

Int!

The version number for optimistic locking.

title

String!

The human-readable display name. Can be localized.

code

A machine-readable code, unique within the catalog scope.

order

Int!

The display order within the same level or category.

catalog

The catalog this item belongs to.

workspace

The workspace that owns this item. Null for system items.

meta

Metadata about this item including description, origin, and display properties.

allowedAssetTypes

The asset types allowed in groups of this type, with optional quantity limits.


assetGroupTypeUpdate

Updates an asset group type.

Arguments

Name
Type
Description

input

AssetGroupTypeUpdateInput!

The input fields for updating the asset group type.

Input types:

AssetGroupTypeUpdateInput

Input for updating an asset group type.

Field
Type
Description

id

ID!

The item ID to update.

version

Int

The current version for optimistic locking. If omitted, auto-increments without conflict check.

title

String

The new display name.

order

Int

The new display order.

allowedAssetTypes

Replace allowed asset types. Null means no change.

meta

The display properties.

AssetGroupTypeConstraintInput

Input for a constraint defining allowed asset types in an asset group type.

Field
Type
Description

assetTypeId

ID!

The asset type ID.

maxItems

Int

The maximum assets of this type. Null means unlimited.

CatalogItemMetaInput

Display properties for catalog items.

Field
Type
Description

description

String

The description.

hidden

Boolean

Whether the item is hidden from regular UI lists.

Output types:

AssetGroupTypePayload

The result of an asset group type mutation.

Field
Type
Description

assetGroupType

The created or updated asset group type.

AssetGroupType (entity)

A type for asset groups with membership constraints.

Implements: CatalogItem, Node, Versioned, Titled

Field
Type
Description

id

ID!

A globally unique identifier.

version

Int!

The version number for optimistic locking.

title

String!

The human-readable display name. Can be localized.

code

A machine-readable code, unique within the catalog scope.

order

Int!

The display order within the same level or category.

catalog

The catalog this item belongs to.

workspace

The workspace that owns this item. Null for system items.

meta

Metadata about this item including description, origin, and display properties.

allowedAssetTypes

The asset types allowed in groups of this type, with optional quantity limits.


assetGroupTypeDelete

Deletes an asset group type.

Arguments

Name
Type
Description

input

CatalogItemDeleteInput!

The input fields for deleting the asset group type.

Input types:

CatalogItemDeleteInput

Input for deleting a catalog item.

Field
Type
Description

id

ID!

The catalog item ID to delete.

version

Int

The current version for optimistic locking. If omitted, auto-increments without conflict check.

Output types:

DeletePayload

The result of a delete mutation.

Field
Type
Description

deletedId

ID!

The ID of the deleted entity.


Objects

AssetGroupType

A type for asset groups with membership constraints.

Implements: CatalogItem, Node, Versioned, Titled

Field
Type
Description

id

ID!

A globally unique identifier.

version

Int!

The version number for optimistic locking.

title

String!

The human-readable display name. Can be localized.

code

A machine-readable code, unique within the catalog scope.

order

Int!

The display order within the same level or category.

catalog

The catalog this item belongs to.

workspace

The workspace that owns this item. Null for system items.

meta

Metadata about this item including description, origin, and display properties.

allowedAssetTypes

The asset types allowed in groups of this type, with optional quantity limits.


AssetGroupTypeConstraint

A constraint defining which asset types can be included in an asset group type.

Field
Type
Description

assetType

The asset type allowed in the group.

maxItems

Int

The maximum number of assets of this type allowed in one group. Null means unlimited.


AssetGroup

A group of assets.

Implements: Node, Versioned, Titled

Field
Type
Description

id

ID!

A globally unique identifier. This ID is opaque and should not be parsed by clients.

version

Int!

The version number for optimistic locking. Incremented on each update. Can be provided in update/delete mutations to prevent lost updates. If omitted, the update proceeds without stale-read protection.

title

String!

The human-readable display name.

workspace

The workspace that owns this group.

type

The group type with membership constraints. Immutable after creation.

color

The color for UI display in hexadecimal format.

currentAssets

The assets currently in this group.

history

The full membership history for this group.


AssetGroupItem

A record of an asset's membership in a group.

Implements: Node

Field
Type
Description

id

ID!

A globally unique identifier. This ID is opaque and should not be parsed by clients.

group

The group containing the asset.

asset

The asset in the group.

attachedAt

The date and time when the asset was added to the group.

detachedAt

The date and time when the asset was removed from the group. Null means the asset is currently attached.


AssetGroupPayload

The result of an asset group mutation.

Field
Type
Description

assetGroup

The created or updated asset group.


AssetGroupTypePayload

The result of an asset group type mutation.

Field
Type
Description

assetGroupType

The created or updated asset group type.


Inputs

AssetGroupFilter

Filtering options for asset groups.

Field
Type
Description

typeIds

[ID!]

Filter by group types (OR within field).

titleContains

String

Partial match on title (case-insensitive contains).


AssetGroupOrder

Ordering options for asset groups.

Field
Type
Description

field

The field to order by.

direction

The direction to order.


AssetGroupItemFilter

Filtering options for asset group items.

Field
Type
Description

activeOnly

Boolean

If true, return only currently attached items.


AssetGroupItemOrder

Ordering options for asset group items.

Field
Type
Description

field

The field to order by.

direction

The direction to order.


AssetGroupCreateInput

Input for creating a new asset group.

Field
Type
Description

workspaceId

ID!

The workspace that will own the group.

typeId

ID

The group type ID. Immutable after creation.

title

String!

The group display name.

color

The color for UI display.

assetIds

[ID!]

Initial list of asset IDs to add to the group.


AssetGroupUpdateInput

Input for updating an existing asset group.

Field
Type
Description

id

ID!

The asset group ID to update.

version

Int

The current version for optimistic locking. If omitted, auto-increments without conflict check.

title

String

The new display name.

color

The new color.

assetIds

[ID!]

Full replacement list of asset IDs in the group. If provided, replaces all current memberships.


AssetGroupDeleteInput

Input for deleting an asset group.

Field
Type
Description

id

ID!

The asset group ID to delete.

version

Int

The current version for optimistic locking. If omitted, auto-increments without conflict check.


AssetGroupItemsAddInput

Input for adding assets to a group.

Field
Type
Description

groupId

ID!

The group ID.

assetIds

[ID!]!

The asset IDs to add.


AssetGroupItemsRemoveInput

Input for removing assets from a group.

Field
Type
Description

groupId

ID!

The group ID.

assetIds

[ID!]!

The asset IDs to remove.


AssetGroupTypeCreateInput

Input for creating an asset group type.

Field
Type
Description

workspaceId

ID!

The workspace that will own the item.

code

The machine-readable code. Auto-generated from title if omitted.

title

String!

The display name.

order

Int

The display order. Auto-calculated as last position if omitted.

allowedAssetTypes

The allowed asset types with optional limits.

meta

The display properties.


AssetGroupTypeUpdateInput

Input for updating an asset group type.

Field
Type
Description

id

ID!

The item ID to update.

version

Int

The current version for optimistic locking. If omitted, auto-increments without conflict check.

title

String

The new display name.

order

Int

The new display order.

allowedAssetTypes

Replace allowed asset types. Null means no change.

meta

The display properties.


AssetGroupTypeConstraintInput

Input for a constraint defining allowed asset types in an asset group type.

Field
Type
Description

assetTypeId

ID!

The asset type ID.

maxItems

Int

The maximum assets of this type. Null means unlimited.


Enums

AssetGroupOrderField

Fields available for ordering asset groups.

Value
Description

TITLE

Order by title.


AssetGroupItemOrderField

Fields available for ordering asset group items.

Value
Description

ATTACHED_AT

Order by attachment date.


Pagination types

AssetGroupConnection

A paginated list of AssetGroup items.

Implements: Connection

Field
Type
Description

edges

A list of edges.

nodes

A list of nodes in the connection (without edge metadata).

pageInfo

Information about the current page.

total

The total count of items matching the filter.


AssetGroupEdge

An edge in the AssetGroup connection.

Implements: Edge

Field
Type
Description

cursor

String!

An opaque cursor for this edge.

node

The asset group at the end of the edge.


AssetGroupItemConnection

A paginated list of AssetGroupItem items.

Implements: Connection

Field
Type
Description

edges

A list of edges.

nodes

A list of nodes in the connection (without edge metadata).

pageInfo

Information about the current page.

total

The total count of items matching the filter.


AssetGroupItemEdge

An edge in the AssetGroupItem connection.

Implements: Edge

Field
Type
Description

cursor

String!

An opaque cursor for this edge.

node

The asset group item at the end of the edge.


AssetGroupTypeConnection

A paginated list of AssetGroupType items.

Implements: Connection

Field
Type
Description

edges

A list of edges.

nodes

A list of nodes in the connection (without edge metadata).

pageInfo

Information about the current page.

total

The total count of items matching the filter.


AssetGroupTypeEdge

An edge in the AssetGroupType connection.

Implements: Edge

Field
Type
Description

cursor

String!

An opaque cursor for this edge.

node

The asset group type at the end of the edge.


Last updated

Was this helpful?