TOtodoist
Templates

Use Template

Changed on

Create a project or a complete setup from a template. Requires data:read_write.

Saved workspace templates can only be used in their associated workspace. Returns the created sync-style graph, with tasks in items and comments in notes.

post/api/v1/templates/{template_id}/use

Request

  • Base URL
    https://api.todoist.com
  • URL
    https://api.todoist.com/api/v1/templates/{template_id}/use
  • Auth
    none declared

Path parameters

template_idstring required

Curated template slug or saved template ID with a UT_ prefix.

Example:reading-list

Request body

localestring

Locale for curated template content, with the template's English fallback.

workspace_idstring nullable

Destination workspace ID. Omit to create personal projects.

folder_idstring nullable

Destination folder for a project template. Requires workspace_id. Unsupported for setups.

Example request

{
  "locale": "en",
  "workspace_id": "1234567",
  "folder_id": "1234568"
}

Response

Successful Response

template_type'project' | 'setup' required

Template type: project or setup.

status'ok' required

Always ok on success.

label_idsstring[] required

Created label IDs.

filter_idsstring[] required

Created filter IDs.

Example response

{
  "template_type": "project",
  "projects": [
    {
      "id": "6XGgm6PHrGgMpCFX",
      "can_assign_tasks": true,
      "can_comment": true,
      "child_order": 1,
      "order_key": "a0",
      "color": "charcoal",
      "icon": "lightbulb",
      "creator_uid": "1234567",
      "created_at": "2025-01-15T10:30:00Z",
      "name": "Inbox",
      "updated_at": "2025-01-16T10:30:00Z",
      "view_style": "list",
      "default_order": 1,
      "default_order_key": "a1V",
      "description": "Tasks for the launch plan",
      "public_key": "550e8400-e29b-41d4-a716-446655440000",
      "access": {
        "configuration": {
          "hide_collaborator_details": true,
          "disable_duplication": true
        }
      },
      "role": "admin",
      "parent_id": "6XGgm6PHrGgMpCFX"
    }
  ],
  "sections": [
    {
      "id": "6fFPHV272WWh3gpW",
      "user_id": "1234567",
      "project_id": "6XGgm6PHrGgMpCFX",
      "added_at": "2025-01-15T10:30:00Z",
      "updated_at": "2025-01-16T10:30:00Z",
      "archived_at": "2025-01-17T10:30:00Z",
      "name": "Groceries",
      "description": "Tasks for the launch plan",
      "section_order": 1,
      "order_key": "a1V"
    }
  ],
  "items": [
    {
      "user_id": "1234567",
      "id": "6XGgmFVcrG5RRjVr",
      "project_id": "6XGgm6PHrGgMpCFX",
      "section_id": "6fFPHV272WWh3gpW",
      "parent_id": "6XGgmFVcrG5RRjVr",
      "added_by_uid": "1234567",
      "assigned_by_uid": "1234567",
      "responsible_uid": "1234567",
      "labels": [
        "priority"
      ],
      "deadline": {
        "date": "2025-02-12",
        "lang": "en"
      },
      "duration": {
        "amount": 30,
        "unit": "minute"
      },
      "added_at": "2025-01-15T10:30:00Z",
      "completed_at": "2025-01-16T10:30:00Z",
      "completed_by_uid": "1234567",
      "updated_at": "2025-01-17T10:30:00Z",
      "due": {
        "date": "2025-02-12",
        "is_recurring": false,
        "lang": "en",
        "string": "tomorrow"
      },
      "priority": 1,
      "child_order": 1,
      "order_key": "a1V",
      "content": "Buy milk",
      "description": "Pick up organic milk",
      "day_order": 1,
      "completed_count": 3,
      "postponed_count": 1
    }
  ],
  "notes": [
    {
      "id": "6XGgmFQrx44wfGHr",
      "posted_uid": "1234567",
      "content": "Looks good to me.",
      "uids_to_notify": [
        "1234567"
      ],
      "posted_at": "2025-01-15T10:30:00Z",
      "reactions": {
        "👍": [
          "1234567"
        ]
      }
    }
  ],
  "project_notes": [
    {
      "id": "6XGgmFQrx44wfGHr",
      "posted_uid": "1234567",
      "content": "Looks good to me.",
      "uids_to_notify": [
        "1234567"
      ],
      "posted_at": "2025-01-15T10:30:00Z",
      "reactions": {
        "👍": [
          "1234567"
        ]
      }
    }
  ],
  "view_options": [
    {
      "id": "123456",
      "object_id": "6XGgm6PHrGgMpCFX",
      "filtered_by": "@urgent",
      "calendar_settings": {
        "visible_day_count": 1
      },
      "property_settings": {
        "order": [
          "due",
          "priority",
          "labels"
        ],
        "properties": {
          "due": {
            "width": 180
          },
          "labels": {
            "is_hidden": true
          }
        }
      }
    }
  ],
  "status": "ok",
  "label_ids": [
    "1234567"
  ],
  "filter_ids": [
    "1234568"
  ],
  "project_ids": [
    {
      "project_id": "6XGgm6PHrGgMpCFX"
    }
  ],
  "reminders": [
    {
      "due": {
        "date": "2025-02-12T09:00:00",
        "lang": "en",
        "timezone": "Europe/Madrid"
      },
      "id": "6XGgmFQrx44wfGHr",
      "is_deleted": false,
      "is_urgent": false,
      "item_id": "6XGgmFVcrG5RRjVr",
      "minute_offset": 30,
      "notify_uid": "1234567",
      "type": "relative"
    }
  ]
}

Changes