authenticated
engagements

Read Engagement Timeline

Paginated, chronological event stream for an engagement.

cursor is the opaque {timestamp}|{event_id} token from the prior page's cursor; reverse=True loads the most-recent page first (used on initial open) then pages backward into older events.

get/engagements/{engagement_id}/timeline

Request

  • Base URL
    https://api-docs.upsmith.com (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

engagement_idstring required

Query parameters

cursorstring nullable
reverseboolean
include_ai_response_changesboolean

Headers

organization-idstring nullable
x-user-idstring nullable
timezonestring
x-actor-emailstring nullable
x-request-sourcestring nullable
x-operation-idstring nullable
x-commit-messagestring nullable
x-confirmation-idstring nullable
x-chat-idstring nullable

Response

Successful Response

totalinteger nullable
cursorstring nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.