List conversations.

get

https://api.podium.com/v4/conversations

List all conversations.

If the cursor parameter is used then all other parameters will be ignored. This is to avoid confusion if passing both a cursor and other parameters which would change what data is being returned.

since is an inclusive (>=) filter on last activity, and matches the lastItemAt field in the response -- not updatedAt, which is the record's own timestamp and moves independently. When polling, overlap your since value with the previous poll and de-duplicate by uid.

Both parameters are optional. Sending neither returns exactly what this endpoint has always returned, including both open and closed conversations.

Required scope: read_messages.

📘
TIP
Use the conversation UID to open a conversation in the inbox with the following URL: https://app.podium.com/inbox/redirect-messages/<CONVERSATION_UID>

Query Params

cursor

string

Retrieves the page of items that comes after the cursor.

limit

integer

0 to 100

Defaults to 10

Max number of items to return per request. Defaults to 10.

locationUid

uuid

Podium unique identifier for location.

order

string

enum

Order by last activity: asc for oldest first, desc for most recent first. Defaults to desc when since is given, and to the historical creation order otherwise. 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 last-activity timestamps 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 conversations whose last activity is at or after this time (inclusive). Compare against the lastItemAt field in the response.

Responses

Callback

Language

Loading…

Response

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

application/json

TIP

200Successful response.

defaultError response.