The monday.com templates API lets you install a template as a background job and poll its installation status. The types below are used as return types across the template query and mutation.

Template

The return type of the use_template mutation.

Field	Type	Description
process_id	`String`	An opaque handle for the background installation. Pass it to `template_installation_status` to poll.

TemplateInstallationStatusResult

The return type of the template_installation_status query.

Field	Type	Description
board_ids	`[ID]!`	The IDs of the boards created so far. Populated incrementally during `IN_PROGRESS`.
board_ids_map	`[BoardIdMapping]!`	Maps each template (source) board ID to the newly created board ID.
is_complete	`Boolean!`	Shorthand for `status == COMPLETE`.
is_failed	`Boolean!`	Shorthand for `status == FAILED`.
process_id	`ID!`	Echo of the input `process_id`.
status	`TemplateInstallationStatus!`	The lifecycle status of the installation.

BoardIdMapping

Maps a template's original board to the board that was created from it.

Field	Type	Description
created_board_id	`ID!`	The newly created board's ID.
source_board_id	`ID!`	The template's original board ID.

TemplateInstallationStatus

The lifecycle status of a template installation, returned on the status field of TemplateInstallationStatusResult.

Enum Value	Description
`PENDING`	The job is queued but has not started yet.
`IN_PROGRESS`	The metadata phase is running — boards are being created as empty shells.
`COMPLETE`	All boards are fully ready, including items, automations, and mirror columns.
`FAILED`	The installation failed; any partially created boards were rolled back.