Returns messages in a room using cursor-based pagination (newest first). For full-history pagination guidance and examples, see https://pivot.app/docs/developers/rest-api/message-retrieval.
messages Array
id String
roomId String
userId String
threadParentMessageId String
inlineReplyMessageId String
parentRecordingId String
recordingPositionTimestamp Integer
hasAttachedBlocks Boolean
blockAttachmentsEnabled Boolean Sticky attachment lifecycle marker. Draft sends copy this to send_block_attachments.
richContent Object
children Array
children Array
children Array (max depth)
detail Integer (max depth)
format Integer (max depth)
mode String (max depth)
style String (max depth)
text String (max depth)
type String (max depth)
mentionName String (max depth)
isUnlinked Boolean (max depth)
rel String (max depth)
target String (max depth)
title String (max depth)
url String (max depth)
direction String (max depth)
indent Integer (max depth)
version Integer (max depth)
checked Boolean (max depth)
value Integer (max depth)
language String (max depth)
listType String (max depth)
textFormat Integer (max depth)
textStyle String (max depth)
mentionUserId String (max depth)
start Integer (max depth)
tag String (max depth)
direction String
format String
indent Integer
type String
textFormat Integer
textStyle String
version Integer
tag String
start Integer
listType String
language String
direction String
format String
indent Integer
type String
version Integer
status String ENUM
reactions Array
userId String
emojis Object
emojiIds Array of String
updatedAt String
receipts Array
userId String
readAt String
attachments Array
id String
fileId String
fileUrl String
displayName String
type String ENUM
mimeType String ENUM
assets Array
id String
referencePrefix String
referenceId String
type String ENUM
transcript Object
text String (max depth)
completedAt String (max depth)
duration Number (max depth)
confidence Number (max depth)
sentences Array (max depth)
chapters Array (max depth)
speakers Array (max depth)
chapterList Object
chapters Array (max depth)
summary Object
shortSummary String (max depth)
longSummary String (max depth)
captions Object
sourceFileId String (max depth)
transcriptAssetId String (max depth)
language String (max depth)
format String (max depth)
webvtt String (max depth)
playlistUrl String (max depth)
createdAt String
createdAt String
updatedAt String
playbackPending Boolean
playbackFailed Boolean
sentAt String
scheduledSendAt String
deletedAt String
createdAt String
updatedAt String
threadRepliesCount Integer
threadUsersIds Array of String
lastThreadReplyAt String
type String ENUM
callEndedAt String
callParticipantUserIds Array of String
threadRootMessageId String
inlineReplySentAt String
inlineReplyThreadRootMessageId String
draftState String
draftRevision Integer
draftSlotRevision String
draftFailureReason String
senderKind String ENUM
assistantId String
agentEvent Object
kind String ENUM
turnId String
stepOrdinal Integer
assistantText Object
text String
toolUse Object
callId String
toolType String ENUM
summary String
toolResult Object
callId String
error String
toolType String ENUM
summary String
approvalCard Object
actionId String
proposalSummary String
requesterUserId String
status String ENUM
revision Integer
decidedByUserId String
decidedAt String
outcome Object
roomId String (max depth)
messageId String (max depth)
sentAt String (max depth)
threadRootMessageId String (max depth)
turnStatus Object
status String ENUM
detail String
turnFinished Object
status String ENUM
messageIds Array of String
stopReason String
usage Object
inputTokens String (max depth)
outputTokens String (max depth)
cacheReadTokens String (max depth)
cacheWriteTokens String (max depth)
agentContext Object
references Array
kind String ENUM
id String
roomId String Recording references carry their storage locator.
recordingCreatedAt String
recordingPositionMs String
requestingUserId String
blocks Array
id String
descriptionSpaceId String
homeSpaceId String
attachedToMessageId String
parentBlockId String
type String ENUM
richContent String
icon String
createdBy String
updatedBy String
vOrder Number
hOrder Number
vOrderV2 String
hOrderV2 String
hideAfter String
unhideAfter String
startAt String
endAt String
isLocked Boolean
allowResponsesStart String
allowResponsesEnd String
responsesAreEditable Boolean
anonymousResponses Boolean
url String
defaultLayout String ENUM
templateType String ENUM
mediaThumbnailTime Number
programmingLanguage String
overrideDisplayNumber Boolean
publicAllowDuplicateAsTemplate Boolean
publicLinkExpiresAt String
publicSharingLevel String ENUM
organizationSharingLevel String ENUM
spaceMemberSharingLevel String ENUM
updatedAt String
createdAt String
deletedAt String
deletedBy String
jwtToken String
pilotToken String
correspondingRoomId String
userIsComplete Boolean Block user data
lastUserViewId String
lastSeenInfo Array
userId String
lastSeenAt String
content String
ancestors Array
type String ENUM
id String
attachments Array
id String
fileId String
fileUrl String
displayName String
createdAt String
videoThumbnailUrl String
videoCaptionsUrl String
videoStoryboardUrl String
videoDuration String
assets Array
id String (max depth)
referencePrefix String (max depth)
referenceId String (max depth)
type String (max depth)
transcript Object (max depth)
chapterList Object (max depth)
summary Object (max depth)
captions Object (max depth)
createdAt String (max depth)
playbackFailed Boolean A terminal playback workflow failure; an absent URL alone can still be pending.
playbackPending Boolean
blockData Array
id String
blockId String
type String ENUM
plainTextContent String
propertyValueDetail Object Kept as property_value_detail for wire-compatibility.
eventAttendanceDetail Object
goalCycleDefinitionDetail Object
createdAt String
updatedAt String
deletedAt String
relatedViewId String
parentBlockDataId String
createdById String
updatedById String
vOrder Number
vOrderV2 String Fractional-index ordering key (base-62) for position_in_view rows.
quizQuestion Object
prompt String (max depth)
responseType String (max depth)
options Array (max depth)
numericalAnswer Number (max depth)
numericalMargin Number (max depth)
correctBoolean Boolean (max depth)
answersIncluded Boolean (max depth)
quizSubmission Object
answers Array (max depth)
score Integer (max depth)
maxScore Integer (max depth)
gradeAssignment Object
subjectUserId String (max depth)
score Number (max depth)
maxValue Number (max depth)
status String (max depth)
graderId String (max depth)
gradedAt String (max depth)
isDefault Boolean (max depth)
skipIfPresent Boolean (max depth)
gradeSettings Object
maxGrade Number (max depth)
defaultGrade Number (max depth)
overwriteExistingGrades Boolean (max depth)
defaultGradeApply Object
overwriteExistingGrades Boolean (max depth)
overwrittenBlockDataIds Array (max depth)
defaultGrade Number (max depth)
maxGrade Number (max depth)
eligibleCount Integer (max depth)
filledCount Integer (max depth)
overwrittenCount Integer (max depth)
views Array
id String
blockId String
order Number
type String ENUM
name String
filterBy Object
groupBy Object
sortBy Object
properties Object
access String ENUM
createdAt String
updatedAt String
createdById String
updatedById String
hideEmptyGroups Boolean
deletedAt String
currentUserAccessLevel String ENUM
richTextCrdtVersion Integer
blocksCursor String
blocksStatus String ENUM
nextCursorSentAt String
nextCursorMessageId String
shardHasMore Boolean
nextPartitionCursor String Always returned. Provides the timestamp to use as cursor_sent_at to query the next older history window. Clients should use the room's created_at to determine when to stop querying older history.
code Integer The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
message String A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
details Array
@type String The type of the serialized message.
Was this guide helpful?