Skip to main content
GET
List conversations

Authorizations

Authorization
string
header
required

Use a workspace API key in the Authorization header. Keys use pk_live_<key_id> for production and pk_test<key_id>_ for test mode.

Query Parameters

customerId
string

Filter by Protodesk customer id.

status
string

Workspace-defined status key. Every workspace is seeded with open, pending, resolved, and closed; workspaces can define their own. Use GET /v1/statuses to list the keys valid for your workspace. Unknown keys are rejected with conversations.unknown_status.

Pattern: ^[a-z0-9][a-z0-9_-]{0,62}$
Example:

"open"

channel
string
externalObjectType
string

Filter by the attached external object's type.

externalObjectId
string

Filter by the attached external object's id.

updatedAfter
string<date-time>

Return only conversations updated strictly after this RFC3339 timestamp. Useful for polling changes since a last sync.

limit
integer
default:25
Required range: 1 <= x <= 100
cursor
string

Opaque keyset cursor from a prior response's nextCursor. Omit for the first page. Malformed or tampered cursors return 400.

Response

Conversations ordered by most recently updated.

data
object[]
required
hasMore
boolean
required

True when more rows exist beyond this page.

nextCursor
string | null

Opaque cursor for the next page. Pass it as the cursor query param. Null when hasMore is false.