Returns messages in a thread using cursor-based pagination (oldest first). For guidance and examples, see https://pivot.app/docs/developers/rest-api/message-retrieval.
Cursor for pagination. Omit for first page.
Required when cursor_sent_at is provided.
messages Array
id String
roomId String
userId String
threadParentMessageId String
inlineReplyMessageId String
parentRecordingId String
recordingPositionTimestamp Integer
hasAttachedBlocks Boolean
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)
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
createdAt String
updatedAt String
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
nextCursorSentAt String Cursor for next page. Only populated when has_more is true. Pass these values as cursor_sent_at and cursor_message_id in the next request.
nextCursorMessageId String
hasMore Boolean True if there are more messages available in this thread. When false, all thread messages have been retrieved. Unlike room messages, threads exist on a single partition, so there is no shard-awareness needed.
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?