Templates

A template is a workspace whose structure is meant to be reused. Saving a workspace as a template lets you stamp out new workspaces — lists, custom fields, automations, forms, and more — without rebuilding them by hand. Templates are Workspace objects in the API with isTemplate: true, so every operation on this page maps to the same workspace queries and mutations you already use, plus a few template-specific ones.

Blue has two kinds of templates:

• Organization templates — saved by your organization, visible only to its members. isOfficialTemplate: false.
• Official templates — curated by Blue and visible to everyone. isOfficialTemplate: true. Only Blue employees can create these.

A template can also be a bundle — a folder of several interconnected workspaces saved and instantiated together, with their cross-workspace links preserved. See Template bundles.

Request

List your organization’s templates with the templates query. It returns a paginated TemplatePagination — an items array of Workspace objects plus a pageInfo block — and takes a TemplateFilterInput. With no filter it returns your organization’s templates (isOfficialTemplate defaults to false, scoped to the company in your X-Bloo-Company-ID header).

query ListTemplates {
  templates(filter: { isOfficialTemplate: false, category: MARKETING }, skip: 0, take: 20) {
    items {
      id
      name
      description
      category
      isOfficialTemplate
      icon
      color
      image {
        thumbnail
        small
      }
    }
    pageInfo {
      hasNextPage
      totalItems
    }
  }
}

To browse Blue’s official templates instead, pass isOfficialTemplate: true. Company and project arguments accept either an ID or a slug.

Parameters

templates arguments

TemplateFilterInput

Response

{
  "data": {
    "templates": {
      "items": [
        {
          "id": "clm4n8qwx000008l0g4oxdqn7",
          "name": "Marketing Campaign",
          "description": "Plan and track a multi-channel campaign.",
          "category": "MARKETING",
          "isOfficialTemplate": false,
          "icon": "rocket",
          "color": "#10B981",
          "image": {
            "thumbnail": "https://blue.app/files/clm4n8qwx-thumbnail.png",
            "small": "https://blue.app/files/clm4n8qwx-small.png"
          }
        }
      ],
      "pageInfo": {
        "hasNextPage": false,
        "totalItems": 1
      }
    }
  }
}

Returns

templates returns a TemplatePagination.

Listing templates with workspaceList

templates is the focused way to read templates, but you can also use the general workspaceList query with isTemplate: true on its ProjectListFilter. This is handy when you want templates and active workspaces from the same query surface, or need workspaceList-only filters such as folderId.

query ListTemplateProjects {
  workspaceList(
    filter: { companyIds: ["company_123"], isTemplate: true }
    sort: [updatedAt_DESC]
    take: 20
    skip: 0
  ) {
    items {
      id
      slug
      name
      description
      category
      isTemplate
      isOfficialTemplate
      color
      icon
      createdAt
      updatedAt
    }
    pageInfo {
      hasNextPage
      totalItems
    }
    totalCount
  }
}

Note that workspaceList’s filter requires companyIds (a list) and does not split organization vs. official templates the way templates does.

Get a single template

Fetch one template by ID or slug with the template query. It takes a TemplateFilterInput, but only templateId is meaningful here — it is required, and omitting it returns a TEMPLATE_NOT_FOUND error. For an organization template, the caller must belong to the owning company; pass companyId to read a template from a specific organization, otherwise it defaults to your header company.

query GetTemplate {
  template(filter: { templateId: "workspace_123" }) {
    id
    name
    description
    category
    isOfficialTemplate
  }
}

To inspect a template’s lists and records, fetch them with the recordLists query against the returned workspace ID — Workspace does not expose its lists or records inline.

Create a workspace from a template

Pass templateId to the createWorkspace mutation to stamp out a new workspace from a template. The template can be one of your organization’s templates or an official template; you supply the new workspace’s name and companyId, and may override description, color, icon, and folderId.

mutation CreateFromTemplate {
  createWorkspace(
    input: {
      templateId: "workspace_123"
      name: "Q1 Marketing Campaign"
      companyId: "company_123"
      description: "Marketing initiatives for Q1"
      color: "#10B981"
    }
  ) {
    id
    name
    slug
  }
}

What gets copied

The background copy includes the template’s full structure and content:

• Lists and records, with their positions and due dates
• Custom fields and tags
• Automations
• Forms
• Documents and wiki pages
• Comments and chats
• Status updates
• Cover and display configuration
• Project user-role definitions

What is not carried over:

• User assignments (the creating user is added as OWNER; other members are not assigned)
• Activity history
• Completed state — records start un-done in the new workspace

Track copy progress

After creating a workspace from a template, poll copyProjectStatus to follow the background copy. It takes no arguments and returns the status of your most recent copy job (or null if none is in flight).

query CopyStatus {
  copyProjectStatus {
    newProjectName
    isTemplate
    isActive
    queuePosition
    totalQueues
  }
}

CopyProjectStatus

Convert a workspace to a template

Save an existing workspace as a template with convertProjectToTemplate. It sets isTemplate: true and returns the updated Workspace. Converting also unarchives the workspace if it was archived and removes it from any folder.

mutation ConvertToTemplate {
  convertProjectToTemplate(input: { projectId: "workspace_123", isOfficialTemplate: false }) {
    id
    name
    isTemplate
    isOfficialTemplate
  }
}

ConvertProjectToTemplateInput

Remove template status

Convert a template back into a regular workspace with removeProjectFromTemplates. It sets isTemplate: false (and isOfficialTemplate: false) and returns the updated Workspace.

mutation RemoveTemplateStatus {
  removeProjectFromTemplates(input: { projectId: "workspace_123" }) {
    id
    name
    isTemplate
  }
}

RemoveProjectFromTemplatesInput

Template bundles

A template bundle is a folder of two or more interconnected workspaces saved together as a single template. Instantiating one creates a folder containing a copy of every member workspace, with their cross-workspace links preserved and re-pointed at the copies — reference, lookup, and rollup fields, record dependencies, and cross-workspace automation targets all resolve against the new workspaces rather than the originals. This lets a template demonstrate a connected set of processes, not just one board.

A bundle is a Folder with isTemplate: true. Like single-workspace templates, bundles are either organization bundles (isOfficialTemplate: false, visible only to the owning organization) or official bundles (isOfficialTemplate: true, curated by Blue, visible to everyone — only Blue employees can create them).

List template bundles

Use the templateFolders query to list bundles. It returns a [TemplateFolder!]! — a lightweight summary of each bundle plus its members, suitable for a gallery — and takes a TemplateFolderFilterInput. With no filter it returns your organization’s bundles (scoped to the company in your blue-org-id header); pass isOfficialTemplate: true for Blue’s official bundles.

query ListTemplateBundles {
  templateFolders(filter: { isOfficialTemplate: false }) {
    id
    title
    color
    isOfficialTemplate
    memberCount
    members {
      id
      slug
      name
      icon
      color
    }
  }
}

TemplateFolderFilterInput

TemplateFolder

Convert a folder to a template bundle

convertFolderToTemplate flags an existing folder — and every workspace inside it — as a template bundle. It returns the updated Folder. The folder must be flat: a bundle cannot contain sub-folders.

mutation ConvertFolderToTemplate {
  convertFolderToTemplate(input: { folderId: "folder_123", isOfficialTemplate: false }) {
    id
    title
    isTemplate
    isOfficialTemplate
  }
}

ConvertFolderToTemplateInput

Instantiate a template bundle

instantiateTemplateFolder spins up a new folder of interconnected workspaces from a bundle. Unlike creating from a single template (which returns null), this mutation returns the destination Folder immediately — the member workspaces are copied in a background job and stream in as each completes. Follow progress with the copyProjectStatus query or project subscriptions.

mutation InstantiateBundle {
  instantiateTemplateFolder(
    input: { companyId: "company_123", templateFolderId: "folder_123", name: "Q1 Launch" }
  ) {
    id
    title
  }
}

InstantiateTemplateFolderInput

Each member is copied with the same content as a single-workspace template (see What gets copied). In addition, links between members are re-pointed at the copies, so the new workspaces reference each other rather than the originals. Links to a workspace outside the bundle are dropped — never left pointing at the source.

Remove bundle status

removeFolderFromTemplates reverts a bundle folder back into a regular folder (isTemplate: false, isOfficialTemplate: false). It returns the updated Folder.

mutation RemoveFolderFromTemplates {
  removeFolderFromTemplates(input: { folderId: "folder_123" }) {
    id
    title
    isTemplate
  }
}

RemoveFolderFromTemplatesInput

Template categories

category is a ProjectCategory enum, shared with createWorkspace and used to group templates in the UI.

Errors

{
  "errors": [
    {
      "message": "Template was not found.",
      "extensions": { "code": "TEMPLATE_NOT_FOUND" }
    }
  ]
}

Permissions

Related

• Create a workspace — createWorkspace, including the templateId path
• Copy a workspace — copyWorkspace for one-off duplication
• List workspaces — workspaceList and its filters
• Lists — read a template’s lists and records
• Project & workspace subscriptions — subscribeToProject and the bundle template events (onConvertFolderToTemplate / onRemoveFolderFromTemplates)