TOtodoist
Templates

Preview User Template

Changed on

Stages and previews a project CSV sent as multipart file or a raw CSV body.

Requires data:read_write because the upload is stored. The response includes the filename for a subsequent import and the graph for editing; project names come from the filename or the X-File-Name header for raw bodies.

post/api/v1/templates/user/preview

Request

  • Base URL
    https://api.todoist.com
  • URL
    https://api.todoist.com/api/v1/templates/user/preview
  • Auth
    none declared

Query parameters

resolve_datesboolean

Resolve due dates and deadlines. Use false for an editor to receive raw date strings for the supported content graph projection. On v1.6+, raw typed dues also include date_type, time and timezone to preserve their meaning when saved.

Send in the query string for raw uploads, or the form for multipart uploads.

Request body multipart/form-data

resolve_datesboolean

Resolve due dates and deadlines. Use false for an editor to receive raw date strings for the supported content graph projection. On v1.6+, raw typed dues also include date_type, time and timezone to preserve their meaning when saved.

filestring binary required

Response

Successful Response

template_type'project' | 'setup' required

Template type: project or setup.

uploaded_file_namestring required

Staged CSV filename owned by the caller. Pass it to /templates/user/import to save the template.

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"
        ]
      }
    }
  ],
  "project_view_options_defaults": [
    {
      "calendar_settings": {
        "color": "PRIORITY",
        "layout": "WEEK",
        "visible_day_count": 3
      }
    }
  ],
  "uploaded_file_name": "1234567_abcdef_weekly-planning.csv",
  "reminders": [
    {
      "id": "6XGgmFQrx44wfGHr",
      "item_id": "6XGgmFVcrG5RRjVr",
      "notify_uid": "1234567",
      "type": "relative",
      "minute_offset": 30,
      "due": {
        "date": "2025-02-12T09:00:00",
        "lang": "en",
        "timezone": "Europe/Madrid"
      }
    }
  ]
}

Changes