Skip to main content

History

Complete reference for history-related methods and models.

Methods​

get_history​

get_history(request: GetHistoryRequest) -> GetHistoryResponse

Get change history for an entity.

Parameters:

  • request - History request (kind, kindId, optional filters)

Returns: GetHistoryResponse with list of history events

Models​

HistoryItem​

Main history event model.

class HistoryItem:
    _id: str                         # History event ID
    taskId: str                      # Task ID
    creatorId: str                   # User who made the change
    createdAt: str                   # Timestamp of change
    data: HistoryData                # Changed data
    key: str                         # Change type key
    type: int                        # Event type
    updatedAt: str                   # Last update timestamp
    boardId: Optional[str]           # Board ID (if applicable)

HistoryData​

class HistoryData:
    _id: str                         # Entity ID
    hrid: Optional[str]              # Human-readable ID
    name: Optional[str]              # Entity name
    taskPriority: Optional[int]      # Task priority (if changed)
    board: Optional[str]             # Board ID (if changed)
    members: Optional[List[str]]     # Members (if changed)
    project: Optional[str]           # Project ID (if changed)
    dueStart: Optional[str]          # Due start (if changed)
    dueEnd: Optional[str]            # Due end (if changed)
    # ... additional fields depending on what changed
Dynamic Fields

HistoryData accepts arbitrary additional fields using extra="allow" configuration, as different change types include different data fields.

Request Models​

GetHistoryRequest​

class GetHistoryRequest:
    kind: Kind                           # Required - Entity type (Task, Project, Board, etc.)
    kindId: str                          # Required - Entity ID
    createdBy: Optional[List[str]]       # Filter by creator member IDs
    dateRangeStart: Optional[datetime]   # Start of date range filter
    dateRangeEnd: Optional[datetime]     # End of date range filter
    limit: Optional[int]                 # Max number of history events to return
    lastLoadedDate: Optional[int]        # Timestamp for pagination (default: 0)
    keys: Optional[List[str]]            # Only include these event keys
    excludeKeys: Optional[List[str]]     # Exclude these event keys
    tasksIds: Optional[List[str]]        # Filter by specific task IDs
    groupsIds: Optional[List[str]]       # Filter by specific group IDs
ParameterTypeRequiredDescription
kindKindYesEntity type — Kind.Task, Kind.Project, Kind.Board, etc.
kindIdstrYesID of the entity to get history for
createdByList[str]NoFilter events by member IDs who made the changes
dateRangeStartdatetimeNoReturn events after this date
dateRangeEnddatetimeNoReturn events before this date
limitintNoMaximum number of events to return
lastLoadedDateintNoTimestamp for pagination (default: 0)
keysList[str]NoOnly include events matching these keys (e.g. ["TASK_CREATED"])
excludeKeysList[str]NoExclude events matching these keys
tasksIdsList[str]NoFilter events related to specific task IDs
groupsIdsList[str]NoFilter events related to specific group IDs
Filtering

Use keys to include only specific event types, or excludeKeys to exclude them. These are mutually exclusive — use one or the other.

Response Models​

GetHistoryResponse​

class GetHistoryResponse:
    type: str                        # Response type ("GetHistory")
    payload: GetHistoryPayload       # Response payload

GetHistoryPayload​

class GetHistoryPayload:
    histories: List[HistoryItem]     # List of history events

See Also​