Thread

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/thread-page/json-schema/thread-page-thread-schema.json",
  "title": "Thread",
  "x-generated": "2026-11-07",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/thread-page-openapi.json#/components/schemas/Thread",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "title": {
      "type": "string",
      "description": "The thread's name as the app shows it: its own, or for a thread still called New thread, the first line of words of its first note, without the @name it was sent to. An Add only connection, which cannot read notes, gets the stored name."
    },
    "url": {
      "type": "string",
      "format": "uri"
    },
    "description": {
      "type": "string",
      "description": "Plain text under the title, with line breaks; empty when the Thread has none. Links in it are plain text. Absent for an Add only connection, which sees titles only."
    },
    "folder": {
      "oneOf": [
        {
          "$ref": "#/$defs/FolderRef"
        },
        {
          "type": "null"
        }
      ]
    },
    "status": {
      "type": "string",
      "description": "A status key of the workspace's list: active, waiting, done or an id from GET /statuses."
    },
    "status_name": {
      "type": "string",
      "description": "The status's word; an unrenamed built-in's in English. Use it to show a status, and `status` to set one."
    },
    "archived": {
      "type": "boolean"
    },
    "trashed": {
      "type": "boolean"
    },
    "revision": {
      "type": "integer"
    },
    "last_activity_at": {
      "type": "string",
      "format": "date-time",
      "description": "When a Note in this Thread last changed. While someone types in a Note it may lag that change by up to 60 seconds, so it is not a change cursor: use a Note's `updated_at`, webhooks or the pull feed."
    },
    "shared": {
      "type": "boolean",
      "description": "People the owner shared it with read it: a connection that reads writes here only where the owner allowed it. A hint, not a boundary."
    }
  },
  "required": [
    "archived",
    "folder",
    "id",
    "last_activity_at",
    "revision",
    "shared",
    "status",
    "status_name",
    "title",
    "trashed",
    "url"
  ],
  "$defs": {
    "FolderRef": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    }
  }
}