Archive API docs
    Jump to

    Narrow by kind with a prefix — q: queries, m: mutations, t: types, g: guides, f: fields and arguments.

    Jump to examples ↓
    Query

    collection

    Return a single Collection by ID for the current workspace, or null if no such Collection exists here.

    Arguments

    id ID! required
    ID of the Collection to fetch, as returned by the collections query for this workspace.

    Returns

    Returns Collection.

    Object, input and enum types open in place — use + to reveal their fields. A type that is already open above the row stops at a ↻ circular marker, and anything nested past the depth limit links out to its own page instead.

    createdAt DateTimeWithZone!
    When the Collection was created.
    customAttributeOptionId ID
    Id of the option that represents this Collection in the ITEM collections custom attribute schema (customAttributeSchemas(entity: ITEM)). It differs from id: use it as the value of a collections custom-attribute condition and to match values in an item's customAttributes. Null for workspaces whose Collections use the older storage.
    group ViewGroup
    Group this Collection belongs to, or null when ungrouped. Populated by moveCollectionToGroup. Always null for workspaces whose Collections use the older storage.
    id ID!
    Unique identifier of the Collection in this workspace. Pass it to addItemToCollections / removeItemFromCollections and to collection(id:).
    itemCount Int!
    Number of items in this workspace tagged with the Collection.
    name String!
    Display name of the Collection.
    updatedAt DateTimeWithZone!
    When the Collection was last updated.