---
updatedAt: 2025-02-14T21:21:38.000Z
agentTools:
  projectIndex: https://developer.liquidplanner.com/llms.txt
---

# events

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "treeitems",
    "version": "1.0"
  },
  "paths": {
    "/workspaces/{workspace_id}/events": {
      "get": {
        "tags": [
          "Event"
        ],
        "summary": "events",
        "security": [
          {
            "Bearer": []
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/event"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "workspace_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer"
            }
          }
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://app.liquidplanner.com/api/v1"
    }
  ],
  "components": {
    "securitySchemes": {
      "Bearer": {
        "type": "apiKey",
        "name": "Authorization",
        "in": "header"
      }
    },
    "schemas": {
      "event": {
        "type": "object",
        "properties": {
          "activity_id": {
            "readOnly": false,
            "description": "ID of the activity most recently used for tracking time against this item, suggested for use as a default",
            "type": "integer"
          },
          "work": {
            "readOnly": true,
            "description": "sum of the work tracked against this item",
            "type": "integer"
          },
          "alerts": {
            "readOnly": true,
            "description": "list of zero or more alerts for this item",
            "type": "string"
          },
          "project_id": {
            "readOnly": true,
            "description": "ID of the project containing this item, if any",
            "type": "integer"
          },
          "client_id": {
            "readOnly": true,
            "description": "ID of the client associated with this item's project, if any",
            "type": "integer"
          },
          "client_name": {
            "readOnly": true,
            "description": "Name of the client associated with this item's project, if any",
            "type": "string"
          },
          "created_at": {
            "readOnly": true,
            "description": "",
            "type": "string"
          },
          "created_by": {
            "readOnly": true,
            "description": "",
            "type": "integer"
          },
          "custom_field_values": {
            "readOnly": false,
            "description": "hash of custom fields and their assigned values for this item",
            "type": "string"
          },
          "done_on": {
            "readOnly": true,
            "description": "the date on which this item was completed, defaulted to today if the item is marked done today",
            "type": "string"
          },
          "started_on": {
            "readOnly": true,
            "description": "the date on which this item was started",
            "type": "string"
          },
          "start_date": {
            "readOnly": false,
            "description": "the date on which this event starts",
            "type": "string"
          },
          "description": {
            "readOnly": false,
            "description": "plaintext summary of this item",
            "type": "string"
          },
          "earliest_finish": {
            "readOnly": true,
            "description": "identical to finish_date",
            "type": "string"
          },
          "earliest_start": {
            "readOnly": true,
            "description": "identical to start_date",
            "type": "string"
          },
          "expected_finish": {
            "readOnly": true,
            "description": "identical to finish_date",
            "type": "string"
          },
          "expected_start": {
            "readOnly": true,
            "description": "identical to start_date",
            "type": "string"
          },
          "p98_finish": {
            "readOnly": true,
            "description": "identical to finish_date",
            "type": "string"
          },
          "global_priority": {
            "readOnly": true,
            "description": "overall rank within the folder tree (\"organize\")",
            "type": "integer"
          },
          "global_package_priority": {
            "readOnly": true,
            "description": "overall rank within the package tree (\"prioritize\")",
            "type": "integer"
          },
          "has_note": {
            "readOnly": true,
            "description": "true if the item has a note",
            "type": "boolean"
          },
          "high_effort_remaining": {
            "readOnly": true,
            "description": "calculated as the availability of the event owner for the duration of the event",
            "type": "integer"
          },
          "is_done": {
            "readOnly": false,
            "description": "if true, then the item is done; it has 0 effort, no schedule dates, and any dependencies on it are satisfied",
            "type": "boolean"
          },
          "is_on_hold": {
            "readOnly": false,
            "description": "if true, then the event is on hold, and will not be scheduled",
            "type": "boolean"
          },
          "effective_is_on_hold": {
            "readOnly": true,
            "description": "if true, then the event is on hold, and will not be scheduled",
            "type": "string"
          },
          "is_packaged_version": {
            "readOnly": true,
            "description": "if true, then this is the packaged version of a packaged item",
            "type": "string"
          },
          "is_shared": {
            "readOnly": false,
            "description": "if true, then the event may be visible on a project portal",
            "type": "boolean"
          },
          "latest_finish": {
            "readOnly": true,
            "description": "identical to finish_date",
            "type": "string"
          },
          "low_effort_remaining": {
            "readOnly": true,
            "description": "calculated as the availability of the event owner for the duration of the event",
            "type": "integer"
          },
          "manual_alert": {
            "readOnly": false,
            "description": "editable, arbitrary string; if nonblank, generates an alert on this item",
            "type": "string"
          },
          "max_effort": {
            "readOnly": false,
            "description": "limit on the number of hours of work; triggers a flag if exceeded",
            "type": "integer"
          },
          "name": {
            "readOnly": false,
            "description": "name of this event",
            "type": "string"
          },
          "assignments": {
            "readOnly": false,
            "description": "array of hashes containing ownership, estimation, expected activities, and other information for the item. WRITABLE ONLY ON NEWLY CREATED ITEMS.  To modify assignments on existing treeitems, use the update_assignment action.",
            "type": "string"
          },
          "parent_id": {
            "readOnly": false,
            "description": "ID of the parent project/folder/package",
            "type": "integer"
          },
          "finish_date": {
            "readOnly": false,
            "description": "the date on which this event ends",
            "type": "string"
          },
          "external_reference": {
            "readOnly": false,
            "description": "arbitrary string; use e.g. to store a reference ID from an external system",
            "type": "string"
          },
          "package_id": {
            "readOnly": false,
            "description": "ID of the package the event belongs to, if any",
            "type": "integer"
          },
          "parent_ids": {
            "readOnly": true,
            "description": "array containing parent_id plus all ancestor ids (including root)",
            "type": "integer"
          },
          "parent_crumbs": {
            "readOnly": true,
            "description": "array containing name of parent plus all ancestor names",
            "type": "string"
          },
          "package_ids": {
            "readOnly": true,
            "description": "array containing package_id plus all package ancestor ids (including root)",
            "type": "integer"
          },
          "package_crumbs": {
            "readOnly": true,
            "description": "array containing name of package plus all package ancestor names",
            "type": "string"
          },
          "occurrences": {
            "readOnly": true,
            "description": "array of schedules for each occurrence of the item",
            "type": "string"
          },
          "space_id": {
            "readOnly": true,
            "description": "space ID",
            "type": "integer"
          },
          "updated_at": {
            "readOnly": true,
            "description": "",
            "type": "string"
          },
          "updated_by": {
            "readOnly": true,
            "description": "",
            "type": "integer"
          },
          "item_email": {
            "readOnly": true,
            "description": "",
            "type": "string"
          },
          "billable_expenses": {
            "readOnly": true,
            "description": "The total of all billable lineitem expenses associated with this treeitem.",
            "type": "string"
          },
          "nonbillable_expenses": {
            "readOnly": true,
            "description": "The total of all nonbillable lineitem expenses associated with this treeitem.",
            "type": "string"
          },
          "total_expenses": {
            "readOnly": true,
            "description": "The total for all lineitem expenses, billable and nonbillable, associated with this treeitem.",
            "type": "string"
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```