Get It Done Logo
Get It Done

Archive a task

POST/v1/tasks/{task_id}/archive

Archives the task (hides it from active lists; no data is deleted) — the SAME operation the external MCP `archive_task` tool executes. Archiving an already-archived task succeeds unchanged. Supports the optional `Idempotency-Key` header.

Required scopes
tasks:write
Availability
All plans
Quota cost
1 API call
Idempotency
Optional Idempotency-Key

Request

Path parameters

FieldTypeDescription
task_idrequiredstringTask short id, e.g. `T-123` (a bare `123` is also accepted on input).e.g. T-123

Response 200

The archived task.

Fields

FieldTypeDescription
idrequiredstringThe task short id — the ONE public task identifier.e.g. T-123
titlerequiredstringe.g. Ship the public API
descriptionrequiredstring | nullFree-text description, or null when unset.
statusrequired"TODO" | "IN_PROGRESS" | "IN_REVIEW" | "COMPLETED" | "BLOCKED"Task workflow status.
priorityrequired"LOW" | "MEDIUM" | "HIGH" | "URGENT" | null
due_daterequiredstring (date-time) | nullDue date, ISO-8601 UTC, or null.
notesrequiredstring | nullRich-text notes of the current version, or null.
story_pointsrequirednumber | null
project_idsrequiredstring[]Ids of the projects the CURRENT version is linked to (a task can belong to several).
parent_task_idrequiredstring | nullThe parent task's short id when this is a subtask, else null.e.g. T-99
archivedrequiredboolean
created_atrequiredstring (date-time)Task creation time (first version), ISO-8601 UTC.
updated_atrequiredstring (date-time)Last content change (current version), ISO-8601 UTC.
▸ Raw response schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The task short id — the ONE public task identifier.",
      "example": "T-123"
    },
    "title": {
      "type": "string",
      "example": "Ship the public API"
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Free-text description, or null when unset."
    },
    "status": {
      "$ref": "#/components/schemas/TaskStatus"
    },
    "priority": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/TaskPriority"
        },
        {
          "type": "null"
        }
      ]
    },
    "due_date": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
        },
        {
          "type": "null"
        }
      ],
      "description": "Due date, ISO-8601 UTC, or null."
    },
    "notes": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Rich-text notes of the current version, or null."
    },
    "story_points": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ]
    },
    "project_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Ids of the projects the CURRENT version is linked to (a task can belong to several)."
    },
    "parent_task_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "The parent task's short id when this is a subtask, else null.",
      "example": "T-99"
    },
    "archived": {
      "type": "boolean"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
      "description": "Task creation time (first version), ISO-8601 UTC."
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
      "description": "Last content change (current version), ISO-8601 UTC."
    }
  },
  "required": [
    "id",
    "title",
    "description",
    "status",
    "priority",
    "due_date",
    "notes",
    "story_points",
    "project_ids",
    "parent_task_id",
    "archived",
    "created_at",
    "updated_at"
  ],
  "additionalProperties": false,
  "description": "A task, projected from its stable identity plus its CURRENT version."
}

Example request

curl
curl -X POST https://app.nowgetitdone.com/v1/tasks/T-123/archive \
  -H "Authorization: Bearer gid_YOUR_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

Possible errors