Skip to main content
GET /v1/projects/{id}/messages Lists the Project’s Messages, with optional resource, conversation, and time filters. Results are eventually consistent.
TypeScript

Parameters

string
required
string (date-time)
Exclusive upper bound on createdAt, RFC 3339. Cannot combine with updatedAt bounds.
string (date-time)
Inclusive lower bound on createdAt, RFC 3339. Cannot combine with updatedAt bounds.
MessageDirection
Message origin: received or dispatched, including later delivery outcomes
string
Comma-separated content types to exclude from resource-scoped Message lists and counts. Requires resourceId. A group is excluded when group is selected or all of its parts are excluded; retained Messages are unchanged. Supported values: attachment, group, message.delete, message.read, poll, poll.update, poll.vote, reaction, space.participants.update, space.typing.update, text, text.update, voice.
SortOrder
Direction along orderBy; desc, the default, is newest first
TimestampOrderBy
Sort timestamp; defaults to the filtered timestamp, otherwise created_at. Must match the time bounds.
integer
Items per page. A value above 200 returns at most 200 items.
string
Token from nextPageToken. Keep the same Project and query.
string
Selects this User’s sent or received Messages. Requires spaceId; cannot combine with resourceId.
Platform
Restricts the page to one platform
string
Resource associated with the Message when sent or received. Can combine with spaceId, but not perspectiveUserId.
string
Requires resourceId or perspectiveUserId. User perspectives use created_at order and exclude time bounds and platform filters.
string (date-time)
Exclusive upper bound on updatedAt, RFC 3339. Cannot combine with createdAt bounds.
string (date-time)
Inclusive lower bound on updatedAt, RFC 3339. Cannot combine with createdAt bounds.

Returns

200 A page of Messages in the requested order. MessagePage Headers: Cache-Control, ETag. The raw response carries these headers; see Raw responses.
array of PlatformMessage
required
Unsupported platforms and records with unsupported data are omitted.
string
Continue with this token, even if items is empty. Omitted when no more pages remain.