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 and cursor)

Returns: GetHistoryResponse with a page of history events (newest first) and pagination info

Models​

HistoryItem​

Main history event model.

class HistoryItem:
    id: str                          # History event ID (alias "_id")
    creatorId: str                   # Member who made the change
    createdAt: str                   # Timestamp of change
    data: HistoryData                # Changed data
    key: str                         # Event key, e.g. "TASK_CREATED"
    type: int                        # Event type
    taskId: Optional[str]            # Task ID (for task events)
    boardId: Optional[str]           # Board ID
    projectId: Optional[str]         # Project ID
    documentId: Optional[str]        # Document ID
    milestoneId: Optional[str]       # Milestone ID
    memberId: Optional[str]          # Member ID
    spaceId: Optional[str]           # Space ID
    agentId: Optional[str]           # Agent ID (for changes made by an agent)
    updatedAt: Optional[str]         # Last update timestamp

HistoryPage​

Cursor pagination info.

class HistoryPage:
    hasMore: bool                    # More events are available
    nextCursor: Optional[int]        # Pass as GetHistoryRequest.nextCursor to load the next page

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
    memberIds: Optional[List[str]]       # Filter by member IDs who made the changes
    boardIds: Optional[List[str]]        # Filter by board IDs
    groupIds: Optional[List[str]]        # Filter by group IDs (requires boardIds)
    agentId: Optional[str]               # Only events of this agent
    eventKeys: Optional[List[str]]       # Only include these event keys
    dateRangeStart: Optional[datetime]   # Start of date range filter
    dateRangeEnd: Optional[datetime]     # End of date range filter
    limit: Optional[int]                 # Page size
    nextCursor: Optional[int]            # Cursor from the previous page
ParameterTypeRequiredDescription
kindKindYesEntity type — Kind.Task, Kind.Project, Kind.Board, etc.
kindIdstrYesID of the entity to get history for
memberIdsList[str]NoFilter events by member IDs who made the changes
boardIdsList[str]NoFilter events by board IDs
groupIdsList[str]NoFilter events by group IDs; applied only together with boardIds
agentIdstrNoOnly events of this agent
eventKeysList[str]NoOnly include events matching these keys (e.g. ["TASK_CREATED"])
dateRangeStartdatetimeNoReturn events after this date
dateRangeEnddatetimeNoReturn events before this date
limitintNoPage size
nextCursorintNopayload.page.nextCursor from the previous response
Deprecated parameters

The old names are still accepted with a DeprecationWarning and mapped to the new ones: createdBy → memberIds, keys → eventKeys, groupsIds → groupIds, lastLoadedDate → nextCursor. excludeKeys and tasksIds are no longer supported by the API and are ignored.

Response Models​

GetHistoryResponse​

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

GetHistoryPayload​

class GetHistoryPayload:
    items: List[HistoryItem]         # Page of history events, newest first
    page: Optional[HistoryPage]      # Pagination info

    @property
    def histories(self) -> List[HistoryItem]: ...  # Deprecated alias for items

See Also​