Retrieve messages from a conversation

get

https://api.podium.com/v4/conversations/{conversation_uid}/messages

Retrieve limited number of messages from a conversation.

since and order are optional; sending neither returns exactly what this endpoint has always returned.

If the cursor parameter is used then all other parameters will be ignored. The cursor carries the since and order of the traversal it came from, so a page walk stays on the same filtered, ordered listing.

Required scope: read_messages.

Path Params

conversation_uid

uuid

required

Podium unique identifier for conversation.

Query Params

cursor

string

Cursor used to access next or previous page in pagination.

order

string

enum

Order by publish date: asc for oldest first, desc for most recent first. Defaults to desc. Use asc when polling, so that a poll interrupted partway resumes from where it stopped rather than restarting. Follow nextCursor until it is null before advancing since: since is inclusive and publish dates are not unique, so moving the watermark mid-traversal skips any records left sharing the boundary timestamp, and leaving it in place repeats the whole page.

Allowed:

since

date-time

Return only messages published at or after this time (inclusive). Compare against the createdAt field in the response, which is the earliest publish date across the message's items. A message whose items span the boundary is still returned whole, so its createdAt can predate since. A message can also be stored after the time it was sent or received, so overlap this value with your previous request and de-duplicate by message uid.

Responses

Callback

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response.

defaultError response.